Import OpenAPI/Swagger definitions

This how-to guide will walk you through importing OpenAPI/Swagger definitions into ClickHelp. 

We only support Swagger 2.0, OpenAPI 3.0, and OpenAPI 3.1. 

Steps

1. To invoke the Import Wizard, click either Import Document on the Projects page or the Import button at the bottom-left of the Topic Editor page.
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, so if you need to import multiple OpenAPI definitions into a single project, run the wizard several times.

5. Click Next.
6. Wait until ClickHelp processes the file.
7. 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