Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Publish API Docs
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Basic concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import from Postman
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Create a new API project
    • Endpoint basics
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Overview
      • Create a new schema
      • Build a schema
      • Generate Schemas from JSON etc.
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environments & services
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Postman scripts reference
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Calling other programming languages
        • Using JS libraries
        • Visualizing responses
        • Script examples
          • Assertion scripts
          • Using variables in scripts
          • Using scripts to modify request messages
          • Other examples
    • Dynamic values Modules
  • Mock API data
    • Overview
    • Smart mock
    • Custom mock
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
    • Mock language (Locales)
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Import endpoints/endpoint cases from other projects
      • Sync data from endpoints/endpoint cases
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Jenkins
      • Integration with Gitlab
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Publish docs sites
    • Folder tree settings
    • Custom layouts
    • Visibility settings
    • Endpoint SEO settings
    • Custom domain
    • Embedding values in document URLs
    • Documentation Search
    • Integrating Google Analytics with Doc Sites
    • CORS Proxy
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • gRPC
    • Use request proxy agents for debugging
    • SOAP/WebService
    • GraphQL
    • WebSocket
    • Socket.IO
    • SSE debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • Apidog MCP Server
    • Overview
    • Conntect API Specification within Apidog Project to AI via Apidog MCP Server
    • Conntect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Conntect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
    • Managing Organizations
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
  • Data & Security
    • Where is Apidog's data stored, and how is data security ensured?
    • How is user data stored? Will this data be public? Or will it be private? Will all data be stored in the cloud?
    • When sending requests, do they go through the Apidog server? Is data security ensured?
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Language settings
    • Data backup
    • Network proxy configuration
    • Hot keys
    • Updating Apidog
    • Generate OpenAPI access token
    • Deleting account
    • Account settings
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. Publish API Docs

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.
publish-docs-sites.jpg

Docs site visibility setting#

Apidog version must be β‰₯ 2.6.39.
After clicking on thePublish button, 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.
docs sites visibility setting.png
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.
password protected API documentation.png
3.
IP Allowlist: Restrict access to your doc site to only the specific IP addresses or ranges that you configure.
IP allowlist settings.png
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.
email allowlist settings.png

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.

Release#

You can create and publish multiple versions of your API documentation. Learn more about publishing API versions.
release settings for API Documentations.jpg

Domain#

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.
domain settings for API documentations.jpg

Customize#

You can customize appearance and layouts for API documentations.
customize appearance and layouts for API documentation.png

Appearance#

Basic info#

basic info for API documentation.png
You can switch to Basic Info to set various basic options for the API documentation, including:
Title
Logo
Favicon
Primary color
Language
Light/Dark mode

Content display#

content display for API documentation.png
InContent display, you can customize which fields to display in API documentation, including:
Base URL
Owners
Show 'Last Modified' Time above Endpoint Description
Show 'Last Modified' Time at Document's End
Request samples
OperationId

Advanced settings#

advanced-settings-api-documentation.png
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

Layout & Navigation#

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

Advanced settings#

advanced-settings-for-api-documentations.jpg

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.

CORS proxy#

You can specify a CORS proxy to avoid issues caused by browser security restrictions. Learn more about CORS Proxy.

Google analytics#

The Apidog doc sites now supports integration with Google Analytics. Learn more about integrating Google Analytics with Doc Sites.

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.

Description#

If the project has been published to the API Hub, then this description will be displayed on API Hub.

Allow 'Export', 'Clone' data#

You can export the released documentation data in main branch.

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.

URL & Slug rules#

Define URL rules for your API documentations.

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.
publishing-docs-sites-introduction-05.png
Only subsites let you set the visibility scope for published docs, allowing you to choose which resources are publicly accessible.
publishing-docs-sites-introduction-06.png
Previous
View the API documentation
Next
Folder tree settings
Built with