Generate API Documentation

This topic describes the steps to generate API documentation from an existing OpenAPI/Swagger definition.

Here are the steps:

1. Click Import on the Projects page or at the bottom-left of the Topic Editor screen.
2. Select the OpenAPI option on the first page of the Import Wizard. 
   
   

   If importing from the Projects page, specify whether you want to create a new project or add topics to an existing one. For a new project, provide the project name and language.

3. Click Next.
4. Specify the path to the OpenAPI/Swagger definition file or drag and drop the file from your computer. Note that the file should be publicly available and not password-protected.
   

   Only a single file can be specified/uploaded at one time, so if you need to import multiple OpenAPI definitions into a single project, run the wizard several times.

5. Choose the Import mode:
   1. As a single topic — all methods are listed in one topic.
   2. Group methods by resource — topics are created for each resource. All methods for this resource are listed in the corresponding topic.
   3. Methods as separate topics — topics are created for each method. Topics are grouped by tags.
      
6. Click Next.
7. Wait until ClickHelp processes the file.
8. On the last Import Wizard page, click Open Project to open the project or Finish to exit the wizard.

That's it! This fast and easy way will allow you to import your OpenAPI definitions into ClickHelp easily. You might also want to learn more about updating imported definitions.

Back
to top