Publish docs sites

Publishing a docs site is distinct from using theQuick Sharefeature. WhileQuick Sharegenerates a shareable link for internal and external partners, serving as a temporary communication method, it’s not intended for long-term use.

In contrast, the Publish Docs Sites feature allows for more robust customization. It lets you personalize the domain name, page design, navigation, and more. This feature is ideal when you need to make your API documentation publicly accessible on your official website.

Publish your docs site

Click on the default main site and then click thePublishbutton.


You can set up the environment as shown in the image below. This will help readers easily debug APIs using the environment you provide.


Docs site visibility setting

Apidog version must be ≥ 2.6.39.

You can easily control the visibility of your published doc sites based on your needs. Simply click thePublish right nowbutton to make your site live.


Available Visibility Settings:

1. Public: Your doc sites will be accessible to all internet users. You can also choose to publish your API documentation on API Hub, a platform operated by Apidog that helps users discover and explore APIs.

2. Password protected: If you prefer to secure your API documentations with passwords, enablePassword protectedand set a password — either by creating your own or generating a random one.


3. IP Allowlist: Restrict access to your doc site to only the specific IP addresses or ranges that you configure.


4. Email Allowlist: Only the emails on your configured email allowlist can access your doc sites by verifying their emails through verification codes. The email allowlist supports wildcards, making it easier to manage access for enterprise emails.


Publishing scope

By default, the scope for publishing documentation is set to allSharedresources. You can configure this in theAPIs. For more details, please refer to Visibility settings.

Publish docs site with multiple API versions

To publish multiple API versions, use theRelease Versionfeature. For more details, check out API Versions.

Publish multiple docs sites

To publish docs across different channels within the same project, you can create additional docs sites during publishing. For easier management, you can duplicate the main site’s configuration for each new site. Each sub-site can also have a unique custom domain name.


Only subsites let you set the visibility scope for published docs, allowing you to choose which resources are publicly accessible.


Permalinks

• Apidog provided domain: Your document will have a default Apidog Subdomain, such as https://vhh2uhkjv7.apidog.io. You can also modify it manually. All Apidog documents use the apidog.io domain.

• Custom Domain: You can bind the Apidog document to your own domain. Learn more about Custom domain.

• Docs Redirect Rules: You can set up redirect rules to automatically redirect users to the correct documentation when URLs change, preventing broken links and ensuring a seamless experience.


Other settings

• Documentation Search: While the published API documentation includes a built-in search feature by default, Apidog offers integration with Algolia to enhance search capabilities. Learn more about documentation Search.
• Publish to API Hub: You can choose to publish your docs on API Hub, an open platform operated by Apidog, designed specifically for sharing and exploring APIs.
• Allow 'Export', 'Clone' Data: You can export the released documentation data in main branch.


Basic settings


You can switch to Basic Setting to set various basic options for the API documentation, including:

• Title
• Logo
• Favicon
• Description
• Primary color
• Language
• Light/Dark mode

Documentation Content Display


InBasic settings, you can also customize which fields to display in the API documentation, including:

• Base URL
• Request samples
• Endpoint Owner
• Endpoint update time
• OperationId

Advanced settings


You can choose to hide some information that you don't want users get accessed to, such as:

• Hide 'Powered by Apidog' (Available for Professional or higher plans)
• Hide 'Run in Apidog' Button (Available for Professional or higher plans)
• Show 'Try it out' Button
• Allow 'Export', 'Clone' Data

Documentation custom layout

You can customize the page layout with ease. Learn more about Custom layouts.