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 文件
  • Back to home
  • 支援中心
  • Apidog 支援中心
  • 匯入/匯出
    • 如何將 API 資料匯入 Apidog?
    • 如何在 Apidog 中匯入 cURL?
    • 如何將 Postman 環境遷移到 Apidog?
    • 如何在匯入 Swagger/OpenAPI 時自動分組端點?
  • 傳送請求
    • Apidog 支援 Socket.IO 嗎?
    • 為什麼參數值中的「+」會被解碼為空格?
    • 如何在 Apidog 中傳送請求?
    • 如何在 Apidog 中傳送 GraphQL 請求?
    • 如何在 Apidog 中傳送 gRPC 請求?
    • 如何在 Apidog 中傳送 SOAP/WebService 請求?
    • 如何在 Apidog 中傳送 WebSocket 請求?
    • Apidog 是否支援 WebSocket API 中的預先請求/測試腳本與斷言?
    • 如何在 Apidog 中傳送 SSE 請求?
    • 如何在資料夾層級新增預設標頭?
    • Apidog 是否支援 gRPC API 中的預請求/測試腳本與斷言?
    • ELANREFUSED.DNS 解析器錯誤
    • 為什麼我在傳送請求時會收到「socket hang up」錯誤?
    • 修復請求錯誤
      • 修正 read ECONNRESET 錯誤
      • 修正 ECONNREFUSED 錯誤
      • 修正 ETIMEDOUT 錯誤
      • 修復 ENOTFOUND: Couldn't resolve host 錯誤
      • 修正 ENOTFOUND: getaddrinfo ENOTFOUND www 錯誤
      • 修復 connect EHOSTUNREACH 錯誤
  • 設計 API
    • 如何在路徑中使用變數?
    • 我可以使用回應元件作為預設回應嗎?
    • 如何查看誰修改過端點?
    • 如何在 Apidog 中批次刪除端點資料夾?
    • 如何批次新增/移除端點路徑的前綴?
    • 如何在 Schema Editor 中移動屬性的層級?
    • 如果某個字串屬性有多個列舉值,並且會用於各種位置,如何在整個文件中一致地引用此 enum?
    • 如何取得 Apidog 資源資料夾 ID?
    • 如何取得 Apidog 的資源資料夾 ID?
    • 如何在 URL 路徑中使用變數?
    • 如果端點、文件或測試情境不小心被刪除了,我該怎麼辦?
    • Apidog 是否支援自訂端點的請求程式碼?
    • 將 Swagger/OpenAPI 匯入 Apidog 時,如何自動分組端點?
    • 如何在模擬回應中產生不重複的陣列資料?
    • 為什麼路徑不支援輸入「#」?
  • 偵錯 API
    • Apidog 如何與第三方金鑰管理系統整合?
    • 為什麼相同的請求在其他工具(例如 Postman)中可以正常運作,但在 Apidog 中卻不行?
    • 如何在 Apidog 中從資料庫取得變數值?
    • 如何將環境從其他工具遷移到 Apidog?
    • 如何在 Apidog 中使用腳本進行斷言?
    • JSONPath 只能擷取陣列。如何在 Apidog 中從陣列內擷取單一元素?
    • 當不同環境有不同的資料庫帳號憑證時,如何在 Apidog 中設定資料庫操作?
    • 如何在自訂腳本中取得服務基礎 URL?
    • 當 API 回應過大時,為什麼 Apidog 會回報超過 Node.js 字串長度上限的錯誤?
    • 控制台列印的大小限制是多少?為什麼列印大型檔案時會出現錯誤?
    • 如何解決 Windows 上的 DB2 資料庫連線錯誤?
    • 為什麼我在 Apidog 中連線到 Oracle 資料庫時會出現 NJS-045 錯誤?
    • 如何在 Apidog 自訂腳本中產生動態值?
    • 為什麼用戶端請求相同端點時成功,但在網頁端除錯時卻發生「無法請求地址」錯誤?
    • 為什麼當回應過大時 Apidog 會回報錯誤?
    • 如何使用 Apidog 錄製端點?
    • 定義端點回應時,是否允許端點沒有回應內容?
    • 如何在自訂腳本中取得服務 baseURL?
    • 如何在 Apidog 中查看原始封包?
    • 為什麼我在發送請求時會看到「Invalid URI xxx」錯誤?
    • 如何在 Apidog 腳本中發出非同步請求?
    • 為什麼我在傳送請求時會看到「Couldn't resolve host」訊息?
    • 主控台列印大小限制是多少?為什麼列印大型檔案時會出現錯誤?
    • 如何在端點請求中上傳檔案?
    • 如果 Apidog 當機或未顯示回應資料該怎麼辦?
    • Apidog 用於 OAuth2.0 的官方重新導向 URI
  • Mock API 資料
    • 如何自動模擬 API?
    • Apidog 模擬可以做什麼?
    • 如何在 Apidog 中模擬固定的 API 資料?
    • 如何在 Apidog 中模擬條件式資料?
    • 如何在 Apidog 中啟用雲端模擬?
    • 如何在 Apidog 中啟用自架模擬?
    • Apidog 支援模擬 WebSocket API 嗎?
    • 為什麼瀏覽器在請求模擬端點時沒有回傳內容?
  • 自動化測試
    • 為什麼測試情境在我的本機用戶端執行時沒有問題,但在 Apidog CLI 或 runner 中執行時會發生錯誤?
    • 如何在 Apidog 中建立測試情境?
    • 如何在測試步驟之間傳遞資料?
    • 為什麼我無法成功引用前置步驟資料?
    • 如何在 Apidog 中使用 foreach 迴圈?
    • 從端點/端點案例同步資料有什麼差異?
    • 如何在 Apidog 中使用測試資料?
    • 如何在 Apidog 的腳本中擷取測試資料?
    • 如何在 Apidog 中批次執行測試情境?
    • 如何在 Apidog 中排程測試任務?
    • 如何在 Apidog 中執行效能測試?
    • 如何在效能測試中查看實際的請求與回應?
    • 如何在 Apidog 中匯出效能測試報告?
    • 如何使用資料庫查詢結果作為循環 API 請求的參數?
    • 在 CI/CD 期間於 ApiDog 中擷取並驗證 Stripe Webhook
    • 如何解決「Error: unable to verify the first certificate on runner」錯誤?
    • General Runner Docker 容器「Not Found」錯誤。
    • 如何在 Apidog Web 版中設定 General Runner 的伺服器主機?
    • 為什麼排程測試情境最後顯示 0 個請求?
    • 如果在 Runner 或 CLI 中找不到檔案上傳參數,我該怎麼辦?
    • 如何使用 Runner 執行包含上傳檔案步驟的測試場景?
    • 如何解決「Error: unable to verify the first certificate on runner」錯誤?
    • 當 Runner 發生問題時,如何存取並搜尋 Runner 日誌以識別問題?
    • 如果端點參數是上傳檔案,且在 Runner 或 CLI 中找不到,該怎麼辦?
    • 為什麼當 API 使用案例變更時,測試步驟不會自動同步?
    • 為什麼在 Markdown 文件中使用多個美元符號會導致部分內容無法正確顯示?
    • 自架 Runner 執行任務後,是否會在伺服器上產生測試報告?
    • 我可以為測試情境中的請求新增統一的前置/後置處理器嗎?
    • 如何在單次自動化測試執行期間保持動態值一致?
  • 發布 API 文件
    • 如何在已發布的文件中隱藏所有 Apidog 標誌?
    • 當 API 規格更新時,API 文件會變更嗎?
    • 如何在 Apidog 中將 API 分享給協作者?
    • 如何自訂 Apidog 文件的網域?
    • 如何在 Apidog 中建立多版本文件?
    • Apidog 中 Publish Docs Sites 的分享範圍
    • Apidog 中 Share Doc 清單的分享範圍
    • 為什麼已發布的 Share Docs 沒有顯示 hostname?
    • 文件使用者如何在共享文件中修改 Base URL?
    • 我可以複製已發布的 Apidog 文件,以便在自己的專案中使用嗎?
    • 如何在 Apidog 線上文件中共用標頭(例如 Token)?
    • 為什麼我的團隊成員找不到已發布的文件?
    • 如何修復自訂網域上的 SSL 憑證過期或 Cloudflare 526 錯誤?
    • 自訂 SMTP 設定成功,但允許清單使用者未收到 OTP 電子郵件
  • Markdown
    • 如何使用卡片連結到 Apidog 內的各種頁面或端點?
    • 為什麼在 Markdown 文件中使用多個 $ 符號時,部分內容無法正確顯示?
    • 如何在 Apidog Markdown 中使用透明背景圖片?
    • 如何設定 Markdown 表格的欄寬?
    • 如何將內部 API、文件、資料結構描述或資料夾插入 Markdown 文件?
    • 如何在 Apidog 卡片元件中新增專案內文件或端點的連結?
  • 分支
    • 如何存取 sprint 分支?
  • 管理
    • 如何靜默安裝 Apidog 用戶端?
    • 為什麼我明明有管理員存取權,卻看到「No Permission」錯誤?
    • 如何查看 Runner 版本號?
    • Apidog 支援 win7 嗎?
    • 為什麼 Apidog 安裝後會顯示錯誤「Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll」?
    • 訂閱變更與退款
    • Web 請求可正常運作,但 App 出現「read ECONNRESET」——為什麼?
    • 為什麼 Windows 系統更新後我無法開啟 Apidog?
    • 為什麼 Apidog 在 Windows 系統更新後無法開啟
  • 帳單
    • 我可以在 Apidog 中為我的團隊設定獨立的帳務帳戶嗎?
    • Apidog 上的團隊存取與帳單問題
    • 受邀團隊成員無法存取 Apidog。
    • 將個人付費團隊轉移至組織
  • 私有化部署
    • Apidog 自託管(企業)版本中的使用者與存取管理
  • Web 與用戶端
    • 下載與安裝 Linux 桌面版
  1. 發布 API 文件

如何在 Apidog 中將 API 分享給協作者?

在 API 開發、溝通與協作中,API 文件在邏輯上是標準做法,但在實務上,仍存在以 Word 或 PDF 格式傳遞檔案的問題。因此,提倡使用線上文件來提升團隊之間的溝通效率。

建立快速分享#

切換到左側的 Share Docs 模組。
點擊「New」建立新的快速分享。一個專案支援多個不同的快速分享,可分發給不同的協作者。每位團隊成員都可以看到所有人建立的所有快速分享。
在新增分享彈出視窗中,你可以自訂以下選項:
標題:此分享的名稱,僅在 Apidog 團隊內可見,用於內部識別,不會顯示在分享的文件中。
環境:選擇線上文件中可用的環境。預設情況下不會選取任何環境。你可以選取多個環境。所選環境會在文件中對讀者可見,並可在使用「Try it out」時用於傳送請求。
如果你在建立文件時選擇 Cloud mock 環境,這等同於為文件讀者啟用一個簡易的沙盒環境。
文件內容:文件有兩個可選元件:Base URL 和請求範例。你可以選擇是否在文件中顯示它們。
Base URL:這是在環境中設定的基礎 URL。如果選取,文件中的每個介面都會顯示完整 URL;如果未選取,文件中的 URL 會以「/」開頭。
請求範例:是否顯示呼叫請求的範例程式碼。詳情請參閱請求範例。
允許匯出資料:是否允許讀者以 OAS/Markdown/HTML/Apidog 格式匯出資料。
分享範圍:選擇此分享要包含哪些 API 端點和 Markdown。你可以依目錄選取,或依標籤篩選與排除。
安全性:你可以設定存取此文件是否需要密碼,以及此文件的到期時間。如果未選擇到期時間,則永不過期。
顯示 API 欄位:你可以設定這些欄位是否顯示在文件中。包括:負責人、更新時間、OperationId、原始連結、需要授權。
語言:此處的語言設定會影響文件中的功能性固定文字,例如「Query Params」「Request samples」等,但不會影響 API 文件內容中撰寫的文字。
進階設定:你可以在此設定隱藏「Try it out」按鈕以及隱藏「Powered by Apidog」。

分享整個資料夾#

快速分享支援「分享整個資料夾」。這適用於以下情境:分享連結後,你可能在資料夾中新增或移除了文件,並希望協作者能同步看到這些變更。
在「分享範圍」中,當你選擇「手動選取」時,可以看到「分享整個資料夾」。啟用後,協作者將始終看到該資料夾中的所有文件,你無需在新增文件後手動修改分享範圍。

請求範例#

你可以在建立分享時選擇是否顯示此模組。
你可以自訂請求範例。方法如下:
1.
在 專案設定 - 功能設定 - 端點功能設定 - 端點欄位 中,啟用請求範例欄位。
2.
接著在 端點 - 編輯 中,最後會出現一個請求範例模組。
3.
你可以在此點擊 新增請求範例,加入你所需語言的範例。之後它會顯示在文件中。
image.png

分享連結#

設定完成後,複製連結分享給團隊成員。
造訪連結以檢視 API 文件。
Modified at 2026-06-11 10:26:02
Previous
當 API 規格更新時,API 文件會變更嗎?
Next
如何自訂 Apidog 文件的網域?
Built with