Skip to main content

Exporting APIs

1. Why have there been fewer exported APIs?

Please check whether there are multiple APIs sharing the same methods and path. Currently, exporting HTML and Markdown is done through OpenAPI data conversion, and the OpenAPI specification does not support using the same methods and paths for different APIs.

2. Why is the API order messed up when exporting Markdown and HTML formats?

The Swagger spec has no concept of order or grouping, so exporting to Swagger will be messy. For strict ordering, export in Apidog format.

3. Why do exported API numbers decrease when multiple APIs have the same URL?

Check for multiple APIs with the same method and path. OpenAPI does not allow this. See API Unique ID. Exporting to HTML/Markdown goes through OpenAPI translation and has the same issue.

4. How to export to PDF?

Currently does not support direct export of data in other formats such as PDF , Word , but you can export Markdown data format first, and then use external tools to convert to the required format.

For example, Typora is a tool that can convert Markdown into PDF, Word, OpenOffice, Epub, and other formats.

5. Why was only one API exported successfully out of multiple APIs?

  1. Please check if there are multiple APIs using the same method and path.
  2. The OpenAPI specification does not support using the same method and path for different APIs. If multiple APIs use the same method and path, please refer to API Unique Identification.
  3. Currently exporting HTML , Markdown is translated through OpenAPI data. There are also problems.

6. How to Export Auth Values?

No additional setup is required, Apidog supports exporting the ​Auth values along with the Swagger format files by default. You can look up the securitySchemes in the Swagger format file.