Using APIPOST to Send HTTP Requests and Manage API Parameters

Sending HTTP Requests

Introduces the API interface layout and explains how to initiate HTTP requests using the APIPOST tool.

API Request Parameters

Header Parameters : You can set or import header parameters, including cookies.

Query Parameters : Supports constructing URL query strings and RESTful path parameters (e.g., :id).

Body Parameters : Offers three body types—form-data, x-www-form-urlencoded, and raw—each with its own UI. Use x-www-form-urlencoded for standard forms, form-data for file uploads, and raw for JSON or other objects.

API Request Response

After clicking the send button, the tool displays returned data, response time, status code, and cookies. The response is shown in a pretty‑printed mode by default, with options to switch to raw view.

Sharing the Documentation

Copying and opening the document URL reveals the complete API documentation.

Filling Parameter Descriptions

For header, query, form-data, and URL‑encoded body parameters, you can add descriptions directly in the interface; previously entered descriptions can be imported quickly via the ♦️ icon.

For raw body parameters, click “Extract fields and description” to generate descriptions automatically.

Filling Response Parameter Descriptions

APIPOST does not automatically include real‑time response examples; you must manually import or copy the response data into the success and error response sections.

As with request parameters, the tool can auto‑match descriptions for previously entered fields.

Overall, the article provides step‑by‑step guidance on configuring requests, handling responses, and managing parameter documentation within APIPOST.