Apidog Docs
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 繁體中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
  1. 發布 API 文件
  • Apidog 學習中心
  • 開始使用
    • Apidog 簡介
    • Apidog 中的基本概念
    • 導覽 Apidog
    • 快速開始
      • 概覽
      • 建立端點
      • 發送請求
      • 新增斷言
      • 建立測試情境
      • 分享 API 文件
      • 探索更多
    • 遷移到 Apidog
      • 概覽
      • 手動匯入
      • 排程匯入(綁定資料來源)
      • 匯入選項
      • 匯出資料
      • 匯入自
        • 從 Postman 匯入
        • 匯入 OpenAPI 規格
        • 匯入 cURL
        • 匯入 Markdown
        • 從 Insomnia 匯入
        • 從 apiDoc 匯入
        • 匯入 .har 檔案
        • 匯入 WSDL
  • Mock API 資料
    • 概述
    • Smart Mock
    • 自訂模擬
    • 模擬優先順序
    • 模擬腳本
    • 雲端模擬
    • 自託管 Runner 模擬
    • 模擬語言(Locales)
  • 帳號與偏好設定
    • 帳戶設定
    • 產生 OpenAPI 存取權杖
    • 通知
    • 語言設定
    • 快捷鍵
    • 網路代理設定
    • 備份資料
    • 更新 Apidog
    • 刪除帳戶
    • 實驗性功能
  • 傳送請求
    • 概覽
    • SSE 偵錯
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 或 WebService
    • GraphQL
    • gRPC
    • 使用請求代理代理程式進行偵錯
    • 建立請求
      • 請求歷史記錄
      • 請求基礎
      • 參數與主體
      • 請求標頭
      • 請求設定
      • 偵錯請求
      • 將請求儲存為端點
      • HTTP/2
    • 驗證與授權
      • 概覽
      • CA 和用戶端憑證
      • 授權類型
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 驗證
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 回應和 Cookie
      • 檢視 API 回應
      • 管理 Cookie
      • 概覽
  • 開發和偵錯 API
    • 概觀
    • 產生請求
    • 傳送請求
    • 偵錯案例
    • 測試案例
    • 動態值
    • 驗證回應
    • Design-First 與 Request-First
    • 產生程式碼
    • 環境與變數
      • 概述
      • 使用變數
      • 環境管理
    • Vault 密鑰
      • 概覽
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 動態值模組
      • Airline
      • 動物
      • 顏色
      • Commerce
      • Company
      • 資料庫
      • Datatype
      • 日期
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • 圖片
      • Internet
      • 位置
      • Lorem
      • 音樂
      • Number
      • Person
      • Phone
      • 科學
      • 字串
      • System
      • Vehicle
      • Word
    • 前置和後置處理器
      • 概覽
      • 斷言
      • 擷取變數
      • Wait
      • 安全性
      • 資料庫操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • 使用腳本
        • 概觀
        • 前置處理器指令碼
        • 後置處理器腳本
        • 公開腳本
        • Postman Scripts Reference
        • 呼叫其他程式語言
        • 使用 JS Libraries
        • 視覺化回應
        • 腳本範例
          • 斷言腳本
          • 使用變數
          • 修改請求
          • 其他範例
    • API 偵錯
      • AI Agent Debugger
      • A2A Debugger
  • 設計 API
    • 概覽
    • 建立新的 API 專案
    • 端點基礎
    • APl 設計指南
    • 模組
    • 設定多個請求主體範例
    • 元件
    • 通用欄位
    • 全域參數
    • 端點變更歷史
    • 留言
    • 批次端點管理
    • 自訂協定 API
    • Spec-first 模式 (Beta)
    • 安全方案
      • 概觀
      • 建立安全性方案
      • 使用 Security Scheme
      • 線上文件中的安全性方案
    • 進階功能
      • 自訂端點欄位
      • 關聯的測試場景
      • 端點狀態
      • 參數列表的外觀
      • 端點唯一識別
    • Schemas
      • 概述
      • 建立新 Schema
      • 建立 Schema
      • 從 JSON 等產生 Schema
      • oneOf, allOf, anyOf
      • 使用 Discriminator
  • API 測試
    • 概述
    • 測試情境
      • 建立測試情境
      • 在請求之間傳遞資料
      • 流程控制條件
      • 從端點和端點案例同步資料
      • 從其他專案匯入端點和端點案例
      • 匯出測試情境
    • 測試報告
      • 測試報告
    • 執行測試情境
      • 執行測試場景
      • 批次執行測試場景
      • 資料驅動測試
      • 共享測試資料
      • 排程任務
      • 管理來自其他專案的 API 執行環境
    • 測試套件
      • 概述
      • 建立測試套件
      • 編排測試套件
      • 在本機執行測試套件
      • 透過 CLI 執行測試套件
      • 排程任務
    • 測試 API
      • 整合測試
      • 效能測試
      • 端對端測試
      • 迴歸測試
      • 契約測試
    • Apidog CLI
      • 概覽
      • 安裝並執行 Apidog CLI
      • Apidog CLI 選項
    • CI/CD
      • 概述
      • 與 Github Actions 整合
      • Integrate with Gitlab
      • 與 Jenkins 整合
      • 透過 Git Commit 觸發測試
  • 發布 API 文件
    • 概述
    • 支援的 API 技術
    • 快速分享
    • 檢視 API 文件
    • Markdown 文件
    • 發佈文件網站
    • 自訂登入頁面
    • 自訂版面配置
    • 自訂 CSS、JavaScript、HTML
    • 自訂網域
    • AI Features
    • SEO 設定
    • 進階設定
      • 文件搜尋
      • CORS Proxy
      • 整合 Google Analytics
      • 資料夾樹設定
      • 可見性設定
      • 在文件 URL 中嵌入值
    • API 版本
      • 概述
      • 建立 API 版本
      • 發佈 API 版本
      • 使用 API 版本分享端點
  • 分支
    • 概觀
    • 建立 Sprint 分支
    • 在分支中測試 API
    • 在分支中設計 API
    • 合併 Sprint 分支
    • 管理 Sprint 分支
    • AI Branch (Beta)
  • AI 功能
    • 概觀
    • 啟用 AI 功能
    • 產生測試案例
    • 使用 AI 修改 Schema
    • 端點合規性檢查
    • API 文件完整性檢查
    • AI 驅動的欄位命名
    • 常見問題
  • Apidog MCP 伺服器
    • 概覽
    • 將 Apidog 專案連接至 AI
    • 將已發布的文件連接至 AI
    • 將 OpenAPI 檔案連接到 AI
  • Apidog Europe
    • Apidog Europe
  • 最佳實務
    • 處理 API 簽章
    • 存取受 OAuth 2.0 保護的 API
    • 協作工作流程
    • 管理驗證狀態
  • 離線空間
    • 概述
  • 管理
    • 管理專案
      • 管理專案
      • 通知設定
      • 管理專案成員
      • 專案資源
        • 資料庫連線
        • Git 連線
    • 管理團隊
      • 管理團隊
      • 管理團隊成員
      • 團隊活動
      • 團隊角色與權限
      • 團隊資源
        • General Runner
        • 團隊變數
        • 請求代理代理程式
      • 即時協作
        • 團隊協作
    • 入門檢查清單
      • 基本概念
      • 入門指南
    • 管理組織
      • 管理組織
      • 組織角色與權限
      • 方案管理
        • 組織中的帳單管理員
      • 單一登入 (SSO)
        • SSO 概覽
        • 設定 Microsoft Entra ID
        • 設定 Okta
        • 為組織設定 SSO
        • 管理使用者帳戶
        • 將群組對應到團隊
      • SCIM 佈建
        • SCIM 佈建簡介
        • Microsoft Entra ID
        • Okta
      • 組織資源
        • 自託管 Runner
  • 帳單
    • 概觀
    • 點數
    • 升級您的方案
    • 替代付款方式
    • 管理訂閱
    • 將付費團隊移至組織
  • 附加元件
    • API Hub
    • Apidog Intellij IDEA 外掛
    • 瀏覽器擴充功能
      • Chrome
      • Microsoft Edge
    • 請求代理
      • Web 中的請求代理
      • 共用文件中的請求代理
      • 用戶端中的請求代理
  • 資料與安全
    • 資料儲存與安全性
    • 使用者資料隱私與安全
    • 請求路由與資料安全
  • 參考
    • API 設計優先方法
    • Apidog OpenAPI 規格擴充
    • JSONPath
    • XPath
    • 正規表示式
    • JSON Schema
    • CSV 檔案格式
    • 安裝 Java 環境
    • Runner 部署環境
    • Apidog Markdown 語法
    • Apidog Swagger 擴充
      • 概述
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 擴充
      • 概述
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 支援中心
  1. 發布 API 文件

發佈文件網站

發佈文件網站會為你的 API 文件建立一個永久、完全自訂的主頁——這不同於 Quick Share 功能,後者是為臨時協作而設計。Quick Share 會產生可分享的連結,用於快速的內部與外部溝通;而 Publish Docs Sites 則提供完整的自訂選項,包括自訂網域、品牌化設計、導覽控制及進階功能。這使其非常適合建立能代表你品牌的專業、公開 API 文件。

先決條件#

在發佈文件網站之前,請確認你具備:
擁有包含 API 文件專案的 Apidog 帳號
該專案的管理員權限
(選用)如果你計畫使用品牌化 URL,請準備自訂網域

初步設定#

發佈你的文件網站#

若要發佈你的文件網站,請前往 Publish Docs 模組並點擊預設主網站,然後點擊 Publish 按鈕。
image.png

文件網站可見性設定#

版本需求
Apidog 版本必須 ≥ 2.7.15,才能存取這些可見性功能。
點擊 Publish 按鈕後,你可以根據安全性與存取需求,控制已發佈文件網站的可見性。點擊 Publish right now 按鈕,即可依你選擇的可見性設定讓網站上線。
image.png
公開
你的文件網站將可供所有網際網路使用者存取。你也可以選擇將 API 文件發佈到 API Hub,這是由 Apidog 營運的平台,可協助使用者探索與查看 API。
密碼保護
IP 允許清單
電子郵件允許清單
自訂登入頁面

發佈範圍#

預設情況下,文件發佈範圍會設為所有 Shared 資源。你可以在 APIs 中設定此項目。如需更多詳細資訊,請參閱 可見性設定。

進階設定#

Try It#

你可以為文件頁面啟用 Try It 功能,讓使用者可以直接在文件頁面上發出 API 請求。
image.png

發佈版本#

你可以建立並發佈多個版本的 API 文件。深入了解如何發佈 API 版本。
API 文件的發佈設定.jpg
相關資源
文件使用者如何在共享文件中修改 Base URL?
如何在 Apidog 線上文件中分享標頭(例如 Token)?

網域設定#

Apidog 提供的網域:你的文件會擁有預設的 Apidog 子網域,例如 https://vhh2uhkjv7.apidog.io。你也可以手動修改。所有 Apidog 文件都使用 apidog.io 網域。
自訂網域:你可以將 Apidog 文件綁定到自己的網域。深入了解 自訂網域。
API 文件的網域設定.jpg

視覺自訂#

你可以自訂 API 文件的外觀與版面配置。
image.png
你可以在這裡即時預覽文件,並在對結果滿意後儲存。
Apidog-01.gif
外觀
版面配置與導覽
自訂登陸頁面
自訂 CSS、JavaScript 與 HTML
在外觀設定中,你可以為 API 文件設定多種基本選項,包括 Title、Logo 和 Favicon。
image.png
在 Display content 下,你可以自訂要在 API 文件中顯示哪些欄位,包括:Base URL、Maintainer 和 Last Modified Time。
image.png

SEO 設定#

設定說明
全域中繼資料設定整個網站的預設中繼資料。
Robots 檔案robots.txt 檔案會指示搜尋引擎要檢索哪些頁面並顯示於搜尋結果中。
Sitemap 檔案sitemap.xml 檔案會向搜尋引擎提供你網站上所有頁面的完整清單,以便更好地建立索引。
文件重新導向規則當 URL 變更時,將使用者重新導向至正確的文件頁面,避免連結失效。
URL 與 Slug 規則定義文件頁面的 URL 結構與 slug 格式。

進階設定#

功能說明
文件搜尋與 Algolia 整合,為已發佈的 API 文件提供增強的搜尋能力。Ask AI 功能可直接在文件搜尋中啟用由 AI 驅動的對話式問答。
CORS Proxy指定 CORS proxy,以避免瀏覽器安全限制可能導致的跨來源問題。
Google Analytics啟用與 Google Analytics 的整合,以追蹤並分析文件網站流量。
發佈到 API Hub將你的文件發佈到 API Hub,這是一個用於分享與探索 API 的開放平台。
描述設定專案若發佈到 API Hub 時,將顯示在 API Hub 上的描述。
允許「Export」、「Clone」資料允許使用者從主分支匯出或複製文件資料。

發佈多個文件網站#

若要在同一專案中跨不同渠道發佈文件,你可以在發佈時建立額外的文件網站。為了更容易管理,你可以為每個新網站複製主網站的設定。每個子網站也可以擁有唯一的自訂網域名稱。
publishing-docs-sites-introduction-05.png
只有子網站能讓你設定已發佈文件的可見性範圍,讓你選擇哪些資源可公開存取。
publishing-docs-sites-introduction-06.png
Modified at 2026-06-11 10:26:02
Previous
Markdown 文件
Next
自訂登入頁面
Built with