Try Interactive API Documentation

Interactive API documentation in Clickhelp allows you to test API calls directly from the browser using the Try it out button.

How Does It Work?

Once you have API docs live, users can click the Try it out button, specify the call parameters, if there are any, and click Execute:

As a result, ClickHelp sends an API call to your server address specified in the OpenAPI definition as the value of the host property.

Authorization

Authorization works precisely like in Swagger — users can specify the authentication header value in the Authorize section if an API call requires authentication. 

It's also possible to define the scopes and the other authentication fields if the API and authorization type require them.

Back
to top