進階發布設定

對於企業級文件，您通常需要對 SEO、網域和樣式有更多的控制權。本節涵蓋了將您的文件提升到新水平的「Pro」功能。

自訂網域

預設情況下，您的文件位於 your-project.apidog.io。雖然功能正常，但看起來不夠正式。您可能想要 developer.your-company.com。

Apidog 透過 CNAME 或反向代理 (Reverse Proxy) 支援自訂網域。

CNAME 配置

這是最常見的方法。

前往 Share Docs > Publish > Custom Domain。

輸入您想要的網域（例如 docs.example.com）。

Apidog 給您一個 CNAME 目標值（例如 shop-api.apidog.io）。

您前往您的 DNS 供應商（GoDaddy, Cloudflare, AWS Route53）並新增一個指向目標的 CNAME 記錄。

反向代理 (進階)

如果您需要文件位於像 example.com/docs 這樣的子路徑下，您必須使用反向代理（如 Nginx 或 AWS CloudFront），因為 CNAME 僅適用於子網域，不適用於路徑。

查看詳情自訂網域

SEO 設定

如果您的 API 是公開的，您希望開發者能在 Google 上找到它。Apidog 內建了 SEO 工具。

導航至發布選單中的 SEO Settings。

全域 Metadata (Global Metadata)

為您的整個網站設定預設值：

標題：例如 "Pet Store API Reference"

關鍵字： "API, Pet Store, REST, Developer Guide"

描述：出現在 Google 搜尋結果中的摘要。

Robots.txt 和 Sitemap

sitemap.xml：Apidog 會自動為您生成此文件，幫助 Google 高效爬取您的端點。

robots.txt：您可以控制允許哪些機器人。例如，如果您正在 Staging 一個新版本且不想讓它被索引，您可以 Disallow: /。

查看詳情 SEO 設定

自訂 CSS 與腳本

有時內建的外觀設定是不夠的。您可能想要：

新增追蹤像素 (Google Analytics)。

聊天小工具 (Intercom, Zendesk)。

從 Adobe Fonts 載入自訂字體。

Apidog 允許您注入原始 HTML、CSS 和 JavaScript。

Header HTML：適合像 Google Analytics 這樣的 <script> 標籤。

CSS：覆蓋特定 UI 元素。例如，更改按鈕的圓角半徑或隱藏特定元素。

警告：小心使用自訂 CSS。如果 Apidog 更新其 UI 結構，您的自訂選擇器可能會失效。

重點摘要

自訂網域：使用 CNAME 將文件託管在您自己的子網域（例如 developer.example.com）上，以獲得專業外觀。

SEO 最佳化：配置 Meta 標籤、描述和 Sitemap，以確保您的 API 文件在搜尋引擎上排名良好。

自訂 CSS/JS：注入自訂腳本以進行分析（Google Analytics）或聊天小工具（Intercom）以增強功能。

Robots.txt：控制搜尋引擎爬取，以防止索引草稿或是私人文件。

繼續閱讀 → 管理 API 版本

自訂網域#

CNAME 配置#

反向代理 (進階)#

SEO 設定#

全域 Metadata (Global Metadata)#

Robots.txt 和 Sitemap#

自訂 CSS 與腳本#

重點摘要#