Advanced Publishing Settings

For enterprise-grade documentation, you often need more control over SEO, domains, and styling. This section covers the "Pro" features that take your docs to the next level.

Custom Domain

By default, your docs live at your-project.apidog.io. While functional, it doesn't look official. You likely want developer.your-company.com.

Apidog supports Custom Domains via CNAME or Reverse Proxy.

CNAME Configuration

This is the most common method.

Go to Share Docs > Publish > Custom Domain.

Enter your desired domain (e.g., docs.example.com).

Apidog gives you a CNAME target value (e.g., shop-api.apidog.io).

You go to your DNS provider (GoDaddy, Cloudflare, AWS Route53) and add a CNAME record pointing docs to the target.

Reverse Proxy (Advanced)

If you need the docs to live at a subpath like example.com/docs, you must use a Reverse Proxy (like Nginx or AWS CloudFront) because CNAMEs only work for subdomains, not paths.

See details Custom domain

SEO Settings

If your API is public, you want developers to find it on Google. Apidog has built-in SEO tools.

Navigate to SEO Settings in the publishing menu.

Global Metadata

Set the defaults for your entire site:

Title: e.g., "Pet Store API Reference"

Keywords: "API, Pet Store, REST, Developer Guide"

Description: The snippet that appears in Google search results.

Robots.txt and Sitemap

sitemap.xml: Apidog automatically generates this for you, helping Google crawl your endpoints efficiently.

robots.txt: You can control which bots are allowed. For example, you might want to Disallow: / if you are staging a new version and don't want it indexed yet.

See details SEO settings

Custom CSS & Scripts

Sometimes the built-in appearance settings aren't enough. You might want to:

Add a tracking pixel (Google Analytics).

Chat widget (Intercom, Zendesk).

Custom font loaded from Adobe Fonts.

Apidog allows you to inject raw HTML, CSS, and JavaScript.

Header HTML: Good for <script> tags like Google Analytics.

Footer HTML: Good for copyright notices or chat widgets.

CSS: Override specific UI elements. For example, changing the border-radius of buttons or hiding specific elements.

Warning: Use custom CSS with care. If Apidog updates its UI structure, your custom selectors might break.

Key Takeaways

Custom Domains: Use CNAME to host docs on your own subdomain (e.g., developer.example.com) for a professional look.

SEO Optimization: Configure meta titles, descriptions, and sitemaps to ensure your API docs rank well on search engines.

Custom CSS/JS: Inject custom scripts for analytics (Google Analytics) or chat widgets (Intercom) to enhance functionality.

Robots.txt: Control search engine crawling to prevent indexing of draft or private documentation.

Continue with → Managing API Versions

Advanced Publishing Settings

Custom Domain#

CNAME Configuration#

Reverse Proxy (Advanced)#

SEO Settings#

Global Metadata#

Robots.txt and Sitemap#

Custom CSS & Scripts#

Key Takeaways#