專業的 API 文件值得擁有專業的網域。預設情況下，Apidog 文件可透過 <subdomain>.apidog.io 網域存取。不過，你可以透過設定自己的網域來自訂此設定，讓你的受眾能在符合組織品牌形象的網域上存取文件。先決條件#
開始設定自訂網域#
若要存取自訂網域設定，請前往側邊欄中的 Publish Docs 選單，然後進入 Publish 設定頁面。你會看到 Custom Domain 區段，可點擊 Edit 按鈕開始設定。自訂網域設定方法#
1.
CNAME（建議）：最容易設定與維護；適用於子網域與根網域，提供最大的彈性。
2.
Reverse Proxy（進階）：需要使用內容傳遞網路（CDN）或在你自己的伺服器上設定反向代理；建議熟悉這些技術的使用者使用。
設定 CNAME#
本節僅適用於你在前一步選擇 CNAME 選項的情況。
設定 CNAME 記錄#
不同 DNS 控制台的欄位名稱與設定步驟可能不同，但核心概念相同。如果你不確定，請向你的 DNS 供應商確認。type 是你想建立的 DNS 記錄類型。在這裡，你需要選擇 CNAME。
name 或 DNS entry 是你輸入子網域的位置。你可能需要輸入完整名稱（例如 docs.example.com），也可能只需要輸入頂級網域之前的部分（例如 docs）。如果你不確定該使用哪一種，請向你的 DNS 供應商確認。
target、value 或 destination 是子網域應指向的位置。當你在 Apidog 的 Publish 設定中選擇 DNS CNAME 選項時，應該會看到此值。它看起來會像 {docsSiteId}.apidog.io。你應輸入完整值（例如 12345678.apidog.io）。
你也可能會看到名為 TTL 的欄位，代表 Time To Live。這是 DNS 記錄可被快取的秒數。如果你不確定要設定什麼，我們建議選擇 Auto 或保留預設值。
CNAME 記錄不能與相同名稱的其他記錄共存。如果你所選擇的子網域已經有 A 記錄、AAAA 記錄、TXT 記錄或任何其他類型的記錄，則需要先移除那些記錄，然後 再新增 CNAME 記錄。
如果你是在 Cloudflare 控制台中設定 DNS，請確保 Cloudflare 的代理功能（橘色雲朵，在你的網域設定中也稱為「Proxy status」）已停用。原因有二：此選項會向公眾隱藏你網域的 DNS 目標，導致 Apidog 無法正確對你的自訂網域執行例行檢查。
變更需要多久才會生效？#
簡短回答：在進入下一步之前，你可能需要等待 10 分鐘到 48 小時，DNS 變更才會生效。還記得我們先前提到的 TTL（Time To Live）欄位嗎？DNS 記錄會被快取一段時間——基於效能考量，這通常是非常好的做法，因為它們通常不會經常變更。當它們_確實_發生變更時，會有一段時間（TTL 值）DNS 快取伺服器需要等到快取過期，才會檢查是否有任何變更並據此運作。在大多數情況下，最好至少等待 10 分鐘，再進入下一個也是最後一個步驟。有時可能會更快更新完成，也可能需要更久。超過 48 小時的情況很少見。想查看這個稱為_傳播_（propagation）的流程進度嗎？你可以使用 DNS 查詢工具，例如 WhatsMyDNS。輸入完整子網域，從下拉清單選擇 CNAME，然後按下 Search 按鈕。世界各地的 DNS 快取伺服器會回應其快取結果。你需要定期檢查這些結果，直到絕大多數都回應你被指派的 CNAME 值。設定 CDN 或你自己的反向代理伺服器#
本節僅適用於你在前一步選擇 Reverse Proxy 選項的情況。
設定 AWS CloudFront#
你可以利用 AWS CloudFront、Cloudflare Enterprise 等雲端供應商提供的 CDN 服務，將其設定為你自己的反向代理伺服器。在以下範例中，我們將設定 AWS CloudFront 作為 Reverse Proxy。2.
設定你的 distribution 設定。以下是你需要變更的值。
| Settings | Value |
|---|
| Origin Domain Name | 設定為 {docsSiteId}.apidog.io |
| Name | origin 的描述。此值可讓你區分同一個 distribution 中的多個 origins，因此必須是唯一的。 |
| Origin Protocol Policy | 設定為僅 HTTP |
| Alternate Domain Names (CNAMEs) | 設定為你的自訂網域名稱（與你在自訂網域設定期間於 Publish 設定中配置的相同） |
| SSL Certificate | 設定為儲存在 AWS Certificate Manager（ACM）中的自訂網域 SSL Certificate。 |
3.
提供 Origin Custom Headers 的資訊（Header Name 和 Value 欄位只有在你提供 Origin Domain Name 後才會出現）
| Header Name | Value |
|---|
| X-Apidog-Docs-Site-ID | 設定為 {docsSiteId} |
{docsSiteId} 是你的 Docs Site ID，可在自訂網域面板中找到。請務必輸入正確的 ID。4.
設定 Default Cache Behavior Settings。以下是你需要變更的值。
| Setting | Value |
|---|
| Viewer Protocol Policy | 選擇 Redirect HTTP to HTTPS |
| Allowed HTTP Methods | 選擇 GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE。 |
| Cache and origin request settings | 選擇 Use legacy cache settings。Headers、Query strings 和 Cookies 選擇 All |
5.
不要啟用 AWS Web Application Firewall (WAF)。
6.
點擊頁面底部的 Create distribution。你會在 CloudFront Distributions 清單中看到新建立的 distribution。請注意，在 distribution 變為 Deployed 之前，Status 會顯示 In progress。
7.
在你的 DNS 中為自訂網域新增一筆 CNAME 記錄，指向你的 Distribution 的 CloudFront Domain Name。你可以點擊 Distribution ID，在 General 分頁下的 Distribution domain name 找到它（例如 fd1fbc7cac6197.cloudfront.net）。
將 Cloudflare 設定為反向代理#
你可以使用 Cloudflare Workers 作為反向代理。這可讓你的網域保持代理狀態（橘色雲朵），同時確保 Apidog 接收到必要的專案識別資訊。2.
點擊 Create Application，然後點擊 Create Worker。（如果系統提示選擇方法，請繼續使用 Start with Hello World!）
3.
為你的 worker 命名（例如 apidog-docs-proxy），然後點擊 Deploy。
4.
點擊 Edit Code，並用以下內容取代現有 script：
你可以在自訂網域面板中找到你的 {docsSiteId}。請務必在 targetHost 和 docsSiteId 變數中輸入正確的 ID。
6.
前往 Worker 的 Settings 分頁，選擇 Domains & Routes，然後點擊 +Add 按鈕。
7.
輸入你的自訂網域（例如 docs.example.com）。Cloudflare 會自動處理 DNS 記錄和 SSL 憑證。
8.
確保你的 Cloudflare SSL/TLS encryption mode 設定為 Full 或 Full (Strict)，以允許 Cloudflare 與 Apidog 之間進行安全通訊。
在將自訂網域附加到你的 worker 之前，請確保該網域（例如 example.com）已新增至你的 Cloudflare 帳戶，且其 nameservers 已啟用。
設定你自己的反向代理伺服器#
你可以為你的 API 文件設定自己的反向代理伺服器。在以下範例中，我們將使用 Nginx 作為反向代理伺服器。1.
將以下內容新增至 Nginx 設定檔，以進行簡易設定。
:8080 {
handle_path /* {
reverse_proxy http://{docsSiteId}.apidog.io {
header_up X-Apidog-Docs-Site-ID {docsSiteId}
header_up Host "docs.example.com"
}
}
}
{docsSiteId} 是你的 Docs Site ID，可在自訂網域面板中找到。請務必輸入正確的 ID。2.
設定你自訂網域名稱的 DNS 記錄，使其指向你的反向代理伺服器。
將 API 文件部署到自訂網域的子目錄#
設定步驟：#
1.
在 Apidog 的 Custom Domain 設定頁面中，輸入你的自訂網域。
2.
選擇 Reverse Proxy 並啟用 Use Subdirectory，然後輸入子目錄路徑。
3.
接著，你需要修改 Web 伺服器的設定檔。假設你使用 Nginx 來代理你的服務，可參考以下設定：
proxy_pass：將用戶端請求轉發到另一台伺服器（例如 Apidog 的 API 文件伺服器）。
proxy_set_header：設定代理伺服器傳送至上游伺服器的請求標頭，確保請求能被正確處理。
/api-docs/ 是自訂網域的子目錄，且在 Nginx 設定中必須以 / 結尾。
http://{docsSiteId}.apidog.io/ 也必須以 / 結尾。
將 {docsSiteId} 替換為你的 Apidog 文件站台 ID。 docs.example.com 是範例自訂網域。請將其替換為你實際的自訂網域。
設定完成後，你需要在伺服器上重新啟動 Nginx。
啟用 HTTPS#
Apidog 的線上文件支援 HTTPS 協定，與 HTTP 相比具有多項優勢：安全資料傳輸：HTTPS 使用 SSL/TLS 加密來確保資料傳輸安全，防止第三方攔截資訊。
SEO 最佳化：搜尋引擎爬蟲偏好使用 HTTPS，因為它提供更好的安全性與隱私保護。因此，HTTPS 網站在搜尋引擎排名中的權威性可能高於 HTTP 網站。
啟用 HTTPS 的步驟：#
1.
前往 Publish 頁面並開啟 Custom Domain 分頁。
2.
開啟 HTTPS 以啟用 HTTPS；你也可以選擇啟用 Always Use HTTPS，以防止通訊遭劫持或中間人攻擊。
SSL 憑證管理#
啟用 HTTPS 後，你可以選擇如何管理 SSL 憑證：由 Apidog 產生：Apidog 將自動產生 SSL 憑證。
疑難排解#
你正在使用 Apidog Europe 嗎？#
如果你正在使用 Apidog Europe，請確保在自訂網域設定中使用正確的網域。Apidog Europe 先前設定中的正確網域為 {docsSiteId}.eu.apidog.com。 
