Interactive API Documentation

Method: let developers try the API directly in the documentation. As the blog's FAQ describes, ClickHelp's built-in Test Request executes real API calls from the browser and shows responses immediately, without external tools.

Try it: live API console

Pick an endpoint, change the parameters, and press Send. This sends a real request to JSONPlaceholder, a free public test API, and shows the live response. Code samples update as you edit.

GET Send ▶

Description

Code sample

cURLJavaScriptPython
Copy

Response

Press Send to execute the request.
// The live response will appear here

Enable Test Request in your ClickHelp docs

  1. Import your OpenAPI (Swagger) definition into ClickHelp, or add request blocks to your topics.
  2. Enable Test Request for the endpoints you want readers to try.
  3. Publish. Readers edit parameters, send the request, and see the live response right on the page — like the console above.
Low maintenance: API docs generated from an OpenAPI definition update when the definition changes, so interactive examples stay in sync with your API.

See also: ClickHelp API documentation use case.