Help-Doc
Document API
Send Requests

Send Requests

TechDoc provides a powerful yet intuitive interface for sending HTTPS and GraphQL API requests. Whether you're making a simple request to retrieve data or performing complex interactions with GraphQL queries, TechDoc ensures a seamless experience for developers and testers. The platform is designed to handle everything from authentication to response analysis, making API testing more efficient and organized.

Creating a New Request

Creating a Request

To send an API request, click the + button to open a new request tab. You can then:

  • Select the request type (HTTPS or GraphQL).

  • Enter the API URL in the input field.

  • Configure your request using various options such as authorization, headers, parameters, and body.

  • Click Send to execute the request and view the response.

Copy of Copy of Untitled Design (8).png

At the top, you will see an input field where you need to enter the API URL. Next to it, you can select the request type—TechDoc supports HTTPS and GraphQL, allowing you to work with different types of APIs effortlessly.

Configuring the Request

TechDoc simplifies API request configuration with dedicated sections:

  • Params – Add query parameters to filter or modify API responses.

  • Authorization – Set authentication using API keys, Bearer Tokens, or Basic Auth.

  • Headers – Define metadata like Content-Type and authentication credentials.

  • Body – Send data for POST/PUT requests in JSON, form-data, or raw text.

  • Script – Automate requests with pre-request and post-response scripts.

  • Cookies – Store and manage session cookies efficiently.

Viewing API Responses

Clicking Send executes the request, displaying:

  • Status Code – Indicates success (200 OK), errors (404 Not Found, 500 Server Error), etc.

  • Response Body – Displays API data in JSON, XML, or plain text.

  • Headers & Cookies – Show metadata like cache settings and authentication details.

Streamlining API Testing

TechDoc provides a structured interface for refining, testing, and documenting APIs, making API testing seamless across REST and GraphQL.

Prev