API Documentation
ClickHelp allows you to create API documentation automatically from OpenAPI definition YAML and JSON files and place it alongside your manuals and guides. Updating your API docs to match the newer source file is as easy as hitting an Update button.
| If you're looking for information about ClickHelp's API functionality, please refer to ClickHelp API. |
The topics created by importing OpenAPI definition files are called auto-topics. Please refer to the following section of our User Manual to learn more about auto-topics and their creation and updating processes: Auto-topics.
Here's an example of the automatically generated API documentation topic from the Swagger Petstore example:
On the left is information about the request: its description, parameters, body schemas, and responses. On the right are request and response samples, as well as an interactive panel to test the requests.
Interactive API Documentation — Testing Requests
ClickHelp generates interactive API documentation based on your specifications. This means that your readers can test API calls directly from the browser using the Test Request button.
After hitting the button, you will be prompted to authenticate, specify parameters, headers, etc. if needed, and you will be able to send a test request.
You can find more information about this here: Try Interactive API Documentation.