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. Learning Center
  • 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. Learning Center

發布 API 文件

如何在已發布的文件中隱藏所有 Apidog 標誌？
「Build with Apidog」標記目前預設會顯示在已發布的文件中。若要隱藏此標記，需要 [Enterprise plan](https://apidog.com/pricing/)。 升級至 Enterprise plan 後，請透過電子郵件 support@apid...
當 API 規格更新時，API 文件會變更嗎？
Apidog 的文件內容會即時更新，始終反映 API 規格中的變更。 如果你不希望 API 文件即時變更，可以使用 Sprint 分支功能。透過在分支中修改 API 定義，變更只有在合併到 main 時才會影響文件。
如何在 Apidog 中將 API 分享給協作者？
在 API 開發、溝通與協作中，API 文件在邏輯上是標準做法，但在實務上，仍存在以 Word 或 PDF 格式傳遞檔案的問題。因此，提倡使用線上文件來提升團隊之間的溝通效率。 建立快速分享 切換到左側的 Share Docs 模組。 點擊「New」建立新的快速分享。一個專案支援多個不同的快速分享...
如何自訂 Apidog 文件的網域？
預設情況下，你的文件可透過 [subdomain].apidog.io 網域存取。不過，你可以透過設定自訂網域來自訂此設定，這表示你的受眾將能夠在符合你組織需求的網域上存取你的文件。 自訂網域可由具有管理員權限的使用者設定。請依照以下步驟設定自訂網域。 啟動自訂網域設定 你可以在專案的 Share ...
如何在 Apidog 中建立多版本文件？
進入專案後，你可以在資料夾樹上方的衝刺分支切換元件中找到「API Versions」選項。點擊後，你將看到目前專案中所有可用的 API 版本。 點擊「New API Version」後，系統會提示你輸入版本號，並選擇初始版本內容。預設情況下，它會從其他現有 API 版本建立完整副本。如果選擇此選項...
Apidog 中 Publish Docs Sites 的分享範圍
Q: Apidog 是否支援為 Publish Docs Sites 選擇特定端點/資料夾/Markdown 範圍的選項？ A: 是的，Apidog 支援這類篩選，讓你可以透過已發布文件，選擇性地讓自訂受眾檢視特定項目。但此選項僅支援子站台，根站台不具備範圍設定功能。 Q: 如何設定 Publis...
Apidog 中 Share Doc 清單的分享範圍
問：透過 Share Doc 分享時，我可以選擇特定資料夾、端點或 Markdown 檔案嗎？ 答：可以，Apidog 支援在 Share Docs 中選擇性分享端點、Markdown 或資料夾。 問：如何確保我的共享文件中只顯示所選的端點和資料夾？ 答：你可以在新的或現有的 Shared Doc ...
為什麼已發布的 Share Docs 沒有顯示 hostname？
1. 為什麼我在試用分支 API 版本時沒有顯示 hostname？ 在 Apidog 中使用單一或多版本的 API 託管站台時（例如，每個版本都有各自的環境），Try it 功能不一定會一致地顯示環境的 hostname 或變數。除非你在發布時設定 Environment，否則這也可能發生在 AP...
文件使用者如何在共享文件中修改 Base URL？
在 Apidog 已發布的文件或快速共享文件中，如果你希望文件使用者能夠設定並修改 Base URL，可以透過設定變數輕鬆實現。具體操作步驟如下： 在 Apidog 專案中，前往某個「環境」頁面，點擊「新增變數」，並輸入變數名稱（例如「BaseURL」）。在該環境「Base URL」對...
我可以複製已發布的 Apidog 文件，以便在自己的專案中使用嗎？
如果你正在使用外部介面文件或 Apidog 中的公開專案，並且想將其複製到自己的工作區，可以透過匯出為 Apidog 格式文件，或依據文件擁有者設定的權限進行複製。 操作方式如下： 檢查匯出或複製權限 前往分享給你的文件連結，並在介面頁面底部尋找「Export」或「Clone」按鈕。 - ...
如何在 Apidog 線上文件中共用標頭（例如 Token）？
每次使用「Try It」測試 API 時，我都必須手動輸入相同的標頭。有沒有辦法自動共用它？ 可以。建議使用變數在 API 請求之間共用標頭。以下是兩種常見方法： 方法 1：直接在 API 的標頭中使用變數 在你的 API 定義中像這樣設定標頭： Authorization: Bearer {{AC...
為什麼我的團隊成員找不到已發布的文件？
Q: 我的團隊成員說「Share Docs」區段是空的，即使我已經發布了一份文件。為什麼會發生這種情況？ A: 在 Apidog 中，只有在專案中擁有 Admin 權限的團隊成員，才能在 Share Docs 下查看已發布的文件。 如果成員被指派為 Editor 或 Read-only，已發布的文件...
如何修復自訂網域上的 SSL 憑證過期或 Cloudflare 526 錯誤？
Q: 為什麼我的自訂網域顯示「Certificate has expired」？ A: 這是因為 Cloudflare 的代理（橘色雲朵）已啟用。當 Cloudflare 接管 HTTPS 時，Apidog 簽發的 SSL 憑證將不再使用，因此會顯示為已過期。 Q: 如何解決憑證過期或 Clo...
自訂 SMTP 設定成功，但允許清單使用者未收到 OTP 電子郵件
問題描述 發布文件網站並啟用 電子郵件允許清單 後，使用者需要透過電子郵件接收一次性密碼（OTP）才能存取文件。 已完成以下設定： 已啟用自訂 SMTP 伺服器 已設定 SMTP 主機、連接埠、使用者名稱和密碼 SMTP 設定測試通過（例如透過 cURL） 然而，在實際使用時，允許清單中的使用者...
Previous
如何在單次自動化測試執行期間保持動態值一致？
Next
如何在已發布的文件中隱藏所有 Apidog 標誌？
Built with