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

自動化測試

為什麼測試情境在我的本機用戶端執行時沒有問題,但在 Apidog CLI 或 runner 中執行時會發生錯誤?
最常見的問題與變數的使用有關。 在 Apidog 本機用戶端中執行時,會使用儲存在你用戶端中的變數「目前值」,且不會同步到伺服器。然而,在 CLI 或 runner 中執行時,會使用儲存在伺服器上的「初始值」。 為了確保在本機和遠端都能順利運作,你需要正確設定初始值和目前值,並保持兩者一致。 ![...
如何在 Apidog 中建立測試情境?
建立測試情境 開啟 Apidog 後,前往「Tests」模組,然後點選搜尋列旁的 + 以建立新的測試情境。為其選擇適當的目錄,並設定優先順序以完成建立。 ![](https://api.apidog.com/api/v1/projects/544525/resources/342962/ima...
如何在測試步驟之間傳遞資料?
在自動化測試情境中,在多個請求之間傳遞資料非常常見。典型案例包括: 請求 1 是登入請求,會回傳 token;請求 2 使用此 token 來請求其他資料。 請求 1 回傳一個 ID;請求 2 根據此 ID 執行操作。 請求 1 回傳一個清單;請求 2 使用此清單中的資料。 針對這類情境,Api...
為什麼我無法成功引用前置步驟資料?
首先,請確認你目前位於「測試」模組中。「引用前置步驟資料」功能僅在測試模組中可用,API 模組中無法使用。 如果你確定目前位於測試模組中,請切換到「Actual Request」分頁,以確認請求中引用的前置步驟資料是否已成功帶入。 如果實際請求中的引用仍顯示為 {{$.n.response.body...
如何在 Apidog 中使用 foreach 迴圈?
當你有一個包含多個元素的陣列(特定內容清單或從先前步驟取得的清單),且需要對清單中的每個項目執行相同操作時(例如,先取得產品清單,然後將清單中的每個產品加入購物車),就需要使用 ForEach 迴圈。 在 ForEach 迴圈中,迴圈內的操作會針對陣列中的每個元素執行。 與 For 迴圈的差異在於,...
從端點/端點案例同步資料有什麼差異?
對於從端點/端點案例匯入的測試步驟,其請求資料可以與關聯的端點規格/案例同步。 將端點/端點案例匯入測試步驟時,你可以選擇 手動 或 自動 模式。 手動 模式適用於多人協作的情境,也就是在專案中,端點規格、開發與測試流程都有明確的分工,且每個流程都有專人負責。這些流程需要資料獨立性,以避免非預期的...
如何在 Apidog 中使用測試資料?
Apidog 支援資料驅動測試,允許你匯入 CSV 或 JSON 格式的測試資料集,並在測試請求中使用它們。 開始使用 建立一個測試場景並新增必要的測試步驟。 準備測試資料。一組測試資料是一個二維表格,其中每一欄代表一個變數,每一列包含這些欄位的一組值,用於單次測試場景迭代。例如...
如何在 Apidog 的腳本中擷取測試資料?
你可以在腳本中存取測試資料變數,如下所示: pm.iterationData.has(variableName:String): function → Boolean: 檢查測試變數是否存在。pm.iterationData.get(variableName:String): function → ...
如何在 Apidog 中批次執行測試情境?
Apidog 支援批次執行多個已設定的測試情境。 在「測試」模組中,點選左側資料夾樹中的資料夾,右側面板會顯示該資料夾內所有測試情境的列表。在此列表中,你可以查看每個測試情境的資訊,例如環境和最近一次執行結果。 你可以選取多個測試情境,然後點選右上角的「批次執行」按鈕,以批次執行這些...
如何在 Apidog 中排程測試任務?
你可以設定「排程任務」,在指定時間自動執行已設定的自動化測試情境,取得任務執行結果,並滿足定期測試與迴歸測試的需求。 :::tip[] 排程任務目前處於 Beta 階段。 若要執行排程任務,你需要先設定 self-hosted Runner。 你可以執行排程任務的次數取決於你訂閱的方案。你可以在 ...
如何在 Apidog 中執行效能測試?
:::tip[]效能測試功能目前處於 Beta 階段。::: 效能測試會向 API 傳送大規模服務請求,以識別效能瓶頸、評估穩定性、揭露壓力下的潛在風險,並確保 API 能在高負載下可靠運作並回應請求。 設定配置項目 在執行效能測試之前,你需要指定測試場景的執行環境,並可選擇性地指定測試資料,以及...
如何在效能測試中查看實際的請求與回應?
Apidog 的效能測試不提供查看實際請求與回應的能力。 這是因為效能測試著重於評估 API 在高負載下的行為,而這些 API 應該已經 100% 通過功能測試。任何問題很可能是由伺服器效能造成,而不是請求/回應內容造成。 因此,查看實際的請求與回應無助於排查效能相關問題。因此,Apidog 的效能...
如何在 Apidog 中匯出效能測試報告?
效能測試目前仍處於 beta 階段,Apidog 尚未支援匯出效能測試報告。你只能在 Apidog 用戶端內檢視結果。
如何使用資料庫查詢結果作為循環 API 請求的參數?
Apidog 支援使用資料庫查詢結果作為參數,以循環執行 API 請求。你可以依照以下步驟操作: 在你的測試場景中,新增一個「資料庫操作」步驟。執行你的 SQL 查詢,並將結果提取到一個變數中(例如 `id`)。請確保你的 SQL 查詢回傳陣列格式的結果。 ![](https:...
在 CI/CD 期間於 ApiDog 中擷取並驗證 Stripe Webhook
問:ApiDog 是否支援直接監聽 Stripe Webhook?不支援,ApiDog 原生不支援監聽 Webhook。不過,你仍然可以透過後端與資料庫來驗證 Webhook 事件。 問:使用 ApiDog 測試 Stripe Webhook 的建議方法是什麼?你可以依照以下步驟進行: 在後端設定...
如何解決「Error: unable to verify the first certificate on runner」錯誤?
執行 Apidog 的 Runner 時,如果遇到「Error: unable to verify the first certificate on runner」錯誤,通常是因為 Runner 無法驗證伺服器的 SSL 憑證。這可能是由於伺服器使用自簽憑證,或憑證鏈中的某個憑證不受信任所導致。 你...
General Runner Docker 容器「Not Found」錯誤。
Q: 問題是什麼?A: 當使用者依照 Apidog 文件(https://docs.apidog.com/general-runner-755233m0)嘗試執行 General Runner Docker 容器時,會遇到「Not Found」錯誤。此錯誤發生在 runner 嘗試連線至端點:htt...
如何在 Apidog Web 版中設定 General Runner 的伺服器主機?
由於瀏覽器安全性限制,Web 版無法從 HTTPS 頁面存取不安全的 HTTP。因此,在 Web 版中設定 General Runner 的伺服器主機可能會失敗。 請改在 Apidog client 中進行設定。
為什麼排程測試情境最後顯示 0 個請求?
Q: 為什麼我的排程測試情境最後顯示 0 個請求? A: 沒有任何請求通過排程任務,因為為排程執行所設定的環境被設為「Private」。在 Apidog 中,當環境為 private 時,排程測試可能無法存取所需的變數,導致請求失敗。 Q: 我該如何修正這個問題? A: 若要解決此問題,請在 Api...
如果在 Runner 或 CLI 中找不到檔案上傳參數,我該怎麼辦?
Apidog 只會儲存本機檔案路徑,而不是檔案本身。因此,當在不同機器上使用 Runner 或 CLI 執行測試時,可能會遇到找不到檔案的錯誤。 若要解決此問題: 將檔案上傳到執行測試情境的 Runner/CLI 機器。 在 Apidog 中,開啟對應的測試步驟,並使用「批次編輯」將檔案路徑參數值...
如何使用 Runner 執行包含上傳檔案步驟的測試場景?
在 Apidog 中,端點請求內的檔案參數實際上只會儲存檔案路徑(而不是檔案本身)。傳送請求時,Apidog 會根據檔案路徑尋找實際檔案,然後再傳送。因此,你需要確保: 將檔案複製到掛載至 Runner volume 的主機目錄。Runner 的 volume 是你在[部署 Runn...
如何解決「Error: unable to verify the first certificate on runner」錯誤?
如果你在使用 Apidog 執行 Runner 時遇到「Error: unable to verify the first certificate on runner」錯誤,通常是因為 Runner 無法驗證伺服器的 SSL 憑證。這可能是由於伺服器使用自簽憑證,或憑證鏈中包含不受信任的憑證所導致。...
當 Runner 發生問題時,如何存取並搜尋 Runner 日誌以識別問題?
使用 the docker ps 命令尋找有問題的 Runner 資訊; 根據 Runner 容器 ID,執行以下命令查詢有效日誌 # View the last 100 lines of the log for container ID abc123, recommended: docke...
如果端點參數是上傳檔案,且在 Runner 或 CLI 中找不到,該怎麼辦?
Apidog 只會儲存檔案的本機路徑,而不會儲存檔案本身。因此,當在不同機器上使用 Runner 或 CLI 執行測試時,可能會出現找不到檔案的錯誤。 解決方案: 將檔案上傳到執行測試情境的伺服器 在 Apidog 中開啟對應的測試步驟,透過參數的批次操作,將檔案路徑參數替換為該機器上的實際路徑...
為什麼當 API 使用案例變更時,測試步驟不會自動同步?
如果步驟是從端點使用案例匯入,並選擇如何 copy當端點的使用案例變更時,步驟不會變更,兩者之間沒有關聯。 如果步驟是從端點使用案例匯入,並選擇「Reference」方法端點使用案例中的任何變更都會同步到測試步驟內容,反之,步驟變更也會同步到端點使用案例。 因此,如果你需要測試步驟與端點使用...
為什麼在 Markdown 文件中使用多個美元符號會導致部分內容無法正確顯示?
Apidog 使用的 Markdown 編輯器會將 $xxxxx$ 解析為數學公式。如果你的內容不是數學公式,但包含多個 $,可能會解析失敗並無法正確顯示。為避免這種情況,可以採用以下方法: 方法 1. 使用行內程式碼區塊 將程式碼內容包含在反引號中,例如 原始內容 ...
自架 Runner 執行任務後,是否會在伺服器上產生測試報告?
測試報告不會儲存在 Runner 本機,請在用戶端中查看。
我可以為測試情境中的請求新增統一的前置/後置處理器嗎?
可以,Apidog 支援為測試情境設定統一的前置/後置處理器。啟用後,情境內的所有請求在情境執行時,都會自動執行相同的前置/後置處理器。 若要啟用此功能: 前往專案設定。 ![img_v3_02mu_2a6d3e2f-8a5b-407c-a0f9-94a28dc692fg.png](htt...
如何在單次自動化測試執行期間保持動態值一致?
動態表達式(例如 {{$person.fullName}})每次被呼叫時都會產生新的值。如果你在測試流程中多次將這類表達式直接指派給變數,可能會導致各步驟之間的資料不一致。 建議做法: 先產生一次動態值,將其儲存在變數中,然後在整個測試中引用該變數。變數在被指派時只會被求值一次,確保整個測試執行期間...
Previous
為什麼瀏覽器在請求模擬端點時沒有回傳內容?
Next
為什麼測試情境在我的本機用戶端執行時沒有問題,但在 Apidog CLI 或 runner 中執行時會發生錯誤?
Built with