Overview

After designing/developing your API in Apidog, you can easily share the API with other colleagues or publish it to the public. Apidog allows you to conveniently publish your API documentation as a webpage.

Share your API documentation

• In Apidog, you can generate beautiful API documentation with a single click from your defined API specifications. Learn more about Quick share.
• The generated API documentation supports "Try it out" functionality and online code generation. Learn more about View the API documentation.
• In Apidog, not only can you publish API documentation to a webpage, but you can also mix Markdown with API documentation, making it part of the user documentation. Learn more about Publish docs sites.
• Apidog also supports customizing the document's navigation bar, custom document domain names, custom page URLs, and more.
• You can customize the folder style and clicking behavior in the documentation.
• Apidog supports publishing multi-version API documentation.

:::highlight purple
Here's an example of published documentation: https://docs.salla.dev/
:::

Differences between two types of documentation

In Apidog, there are two ways to publish documentation.

The first, "Quick Share," is generally used for intra-team or cross-team collaboration, allowing you to share partial API documentation with collaborators. The second, "Publish Docs," is used to publicly publish the entire documentation.