DevForge LogoDevForgeDocs
Search
LandingWorkbench

Overview

Home

Guides

Markdown Reference

GFM syntax guide

Studio

DevForge Studio

studio

Data Tools

JSON Formatter

json-formatter

Base64 Ultimate Studio

base64-ultimate-studio

JWT Decoder

jwt-decoder

String Case Converter

string-case-converter

YAML ↔ JSON

yaml-json-converter

DB Schema Visualizer

db-schema-visualizer

API Client Studio

api-client

SHA-256 Hash Generator

sha256-generator

SVG Optimizer

svg-optimizer

Writing Tools

Markdown Editor

markdown-editor

ASCII Art Generator

text-to-ascii-art

Doc Builder

doc-builder

Pattern Tools

Regex Tester

regex-tester

Diff Viewer

diff-viewer

Generators

Code Generator

code-generator

UUID Generator

uuid-generator

Color Palette Studio

color-palette

Cron Generator

cron-generator

Dockerfile Generator

dockerfile-generator

K8s YAML Builder

k8s-yaml-builder

AI Tools

AI Explainer

code-explainer

AI UI Generator

ai-ui-generator

Documentationapi client

Tool reference

API Client Studio

alpha

Test, inspect, and automate REST and GraphQL APIs. A full-featured HTTP studio built directly into your workspace supporting collections, custom environments with variable interpolation, pre-request scripts, test assertions, and multi-language snippet generation.

Open toolBack to docs

Quickstart

Use this when you want the shortest path from input to a useful result.

1

Open API Client Studio from the sidebar or tool list.

2

Select the HTTP method (GET, POST, etc.) and enter the URL in the main request bar.

3

Switch to the Params, Auth, Headers, or Body tab to customize request parameters.

4

Click Send to dispatch. Inspect the response status, headers, body tree, and test results in the bottom panel.

Best for

Common situations where this tool fits naturally into the workflow.

  • Interactively debug external and internal REST endpoints with full control over headers, query strings, and request body formats.
  • Organize requests into folder-based collections for structural order, persistence, and repeatability.
  • Use dynamic environments and variables to manage API keys, base URLs, and parameters across local, staging, and production environments.
  • Write automated response assertions and test suites to verify status codes, payload shapes, and response times.
  • Simulate complex workflows using pre-request scripts to dynamically sign payloads, set headers, or configure environment state before sending.
  • Generate production-ready integration code snippets for multiple programming languages and HTTP libraries.

Common tasks

Concrete ways this tool is typically used in day-to-day workflows.

Import cURL Commands

Click 'Import cURL' at the top of the interface, paste any raw cURL command from your developer tools or documentation, and click Import. The client automatically parses the HTTP method, target URL, headers, query parameters, and raw body payload.

GraphQL Request with Variables

Switch the HTTP method to POST. Under the Body tab, select the 'GraphQL' option. Enter your query schema in the query panel, and specify any variables in the JSON variables editor. The client automatically wraps the payload for GraphQL compliance.

Environment Variables Interpolation

Go to the Environments tab in the sidebar. Create a new environment (e.g. 'Staging') and add variable key-value pairs like baseUrl and apiKey. Switch the active environment dropdown, and reference them in any URL, header, or body field using {{baseUrl}} or {{apiKey}}.

Postman Collection Import

Import existing Postman collections by uploading or pasting the exported JSON file. The tool parses folders, requests, headers, and parameter definitions directly into your sidebar Collection tree.

Pre-request and Test Assertions Scripting

Use the Settings/Scripts panel. In Pre-request, write JS code to run before dispatch. In Tests, use Postman-compatible `pm.test` and `pm.expect` calls to run assertions. Test outcomes are rendered inline on the response panel.

Collection Runner Automation

Run all requests in a folder sequentially. Select a collection, configure request delays, click the Run button, and view the real-time runner board showing passing/failing tests, timing, and status codes.

Examples

Real inputs and outputs that show how the tool behaves.

REST GET Request with Auth

A standard API call with bearer authentication and custom headers.

Request Config

Method: GET
URL: https://api.github.com/user/repos?per_page=5
Header: Authorization: Bearer {{github_token}}
Header: User-Agent: DevForge-Client

JSON Response

[
  {
    "id": 7623910,
    "name": "devforge",
    "full_name": "playkashyap/devforge",
    "private": true
  }
]

GraphQL Query

Query a GraphQL server with target variables.

GraphQL Query & Variables

query GetRepository($owner: String!, $name: String!) {
  repository(owner: $owner, name: $name) {
    stargazerCount
  }
}

Variables:
{
  "owner": "playkashyap",
  "name": "devforge"
}

GraphQL Response

{
  "data": {
    "repository": {
      "stargazerCount": 42
    }
  }
}

Features

What this tool includes and what each capability is for.

HTTP & REST Client

Supports GET, POST, PUT, DELETE, PATCH, and HEAD methods with customizable parameters, headers, and request bodies.

Dynamic Environment Settings

Swap environment variable contexts dynamically and reuse configurations with {{variable}} placeholders.

Collection Runner

Execute folder-nested requests sequentially with delays, validating test suites dynamically.

Code Snippet Generator

Generate integration code in cURL, JavaScript Fetch, Axios, Python requests, and HTTPie formats.

GraphQL IDE Interface

Dedicated GraphQL body editor featuring syntax highlight, query schema formatting, and separate variables panel.

Script Sandbox Runtime

Inject custom JavaScript pre-request scripts and write automated post-response test suites with pm-compatible APIs.

Workflow

Follow this path to get from input to output quickly.

1

Select your active environment (e.g. Development, Production) from the header dropdown to apply variables.

2

Configure the HTTP method and request URL. Use double curly brackets to inject variables (e.g. {{baseUrl}}/users).

3

Add parameters, headers, or authentication tokens in the request settings tabs.

4

For POST/PUT requests, open the Body tab and select JSON, Text, or GraphQL, then paste the request payload.

5

Go to the Scripts panel to write pre-request variable setup or test assertions (e.g. status assertions).

6

Click Send to execute. Review status code, headers, and JSON/Text body representation in the response panels.

7

Check the Tests tab in the response panel to view passed/failed assertions, or the Code tab to copy integration snippets.

Caveats and tips

Things to keep in mind before relying on the output in a larger workflow.

Caveats

  • When using proxy mode, requests go through the DevForge backend to bypass CORS limitations of browsers.
  • Sensitive credentials stored in local environments should not be committed to shared catalogs.
  • File uploads and binary requests are restricted to small sizes to maintain workbench performance.
  • Script sandbox executes client-side JavaScript only and does not support full Node.js APIs or require statements.

Tips

  • Toggle the Sidebar layout using the chevron icons to maximize workspace screen area when writing complex GraphQL queries.
  • Inspect the timing stats in the response footer (TTFB, Transfer, and Total duration) to measure API response times accurately.
  • Click 'Copy Result' in the response toolbar to quickly format and save the parsed JSON response body directly to your clipboard.
  • Verify JSON body structure with the real-time syntax checking warnings in the editor before dispatching requests.
  • Use the JS Fetch or Axios snippet generators in the code tab to generate instant copy-paste code for your frontend components.

On this page

QuickstartBest forCommon tasksExamplesFeaturesWorkflowCaveats and tips

Related pages

JSON FormatterOpenBase64 Ultimate StudioOpenJWT DecoderOpenString Case ConverterOpen