Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
HomeLearning CenterSupport CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Publish API Docs
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Navigating Apidog
    • Basic concepts in 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 to Apidog
      • 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
    • APl design guidelines
    • Module
    • Configure multiple request body examples
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Comments
    • Batch endpoint management
    • Custom Protocol API
    • Schemas
      • Overview
      • Create a new schema
      • Build a schema
      • Generate Schemas from JSON etc.
      • oneOf, allOf, anyOf
      • Using discriminator
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Associated test scenarios
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique identification
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Debug cases
    • Test cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Environment Management
      • Using variables
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Postman scripts reference
        • 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)
  • API Testing
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Sync data from endpoints/endpoint cases
      • Import endpoints/endpoint cases from other projects
      • 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 Github Actions
      • Integrate with Jenkins
      • Integrate with Gitlab
      • Trigger Test by Git Commit
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Markdown documentations
    • Publish docs sites
    • Custom layouts
    • Custom CSS, JavaScript, HTML
    • Custom domain
    • LLM-friendly Features
    • SEO settings
    • Advanced Settings
      • Documentation Search
      • CORS Proxy
      • Integrating Google Analytics with Doc Sites
      • Folder tree settings
      • Visibility settings
      • Embedding values in document URLs
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • SSE debugging
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP/WebService
    • GraphQL
    • gRPC
    • Use request proxy agents for debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • Debug requests
      • Save the request as an endpoint
      • HTTP/2
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
    • 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
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • AI Features
    • Overview
    • Enable AI features
    • Generate Test Cases
    • Modify schemas with AI
    • Endpoint compliance check
    • AI naming
    • FAQs
  • Apidog MCP Server
    • Overview
    • Connect API Specification within Apidog Project to AI via Apidog MCP Server
    • Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Connect 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
  • Offline Space
    • Overview
  • 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
        • Git Connection
    • Managing Organization
      • Managing Organization
      • 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
      • Plans management
        • Billing managers in organization
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
    • How to move a paid team to a organization?
  • 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
    • Account settings
    • Generate OpenAPI access token
    • Notification
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • 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.
CleanShot 2025-10-28 at 15.35.42@2x.png

Docs site visibility setting#

Apidog version must be β‰₯ 2.7.15.
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.
image.png
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.
Password protected
IP Allowlist
Email Allowlist
Custom Login Page

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
How Can Document Users Modify the Base URL in Shared Docs?
How to Share Headers (e.g., Token) in Apidog Online Docs?

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.
image.png
You can preview your document in real time here and save it once you're satisfied with the result.
Apidog-01.gif

Appearance#

In Appearance Settings, you can configure various basic options for your API documentation, including:
Title
Logo
Favicon
Primary color
Language
Light/Dark mode
image.png
InDisplay content , you can customize which fields to display in API documentation, including:
Base URL
Maintainer
Show 'Last Modified' Time above Endpoint Description
Show 'Modified at' Time at Document's End
Request Code Samples
Hide 'Run in Apidog' Button (Available for Professional or higher plans)
Show 'Try it' Button
Allow 'Export', 'Clone' Data
...
image.png

Layout & Navigation#

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

Custom Landing Page#

You can customize the homepage of your publish docs using either Markdown or HTML with CSS and JavaScript.
image.png

Custom CSS, JavaScript, and HTML#

You can configure global CSS, JavaScript, and footer HTML. For more details, see the Custom CSS, JavaScript, HTML documentation.
image.png

Advanced settings#

image.png

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
Modified atΒ 2025-10-29 07:15:48
Previous
Markdown documentations
Next
Custom layouts
Built with