契約測試

契約測試用於驗證實際 API 回應是否符合 API 文件（OpenAPI）中定義的規格。透過對狀態碼與回應結構等內容進行一致性檢查，可在開發、偵錯與測試階段及時發現實作與文件之間的不一致，確保服務之間的 API 行為穩定且可靠。

Apidog 的回應驗證（契約測試）能力與 API 文件深度整合。它可用於 API 請求、偵錯案例、測試案例以及自動化測試步驟中。這是一項預設啟用的基礎功能。

啟用回應驗證

回應驗證可依模組啟用，並可根據業務需求在不同階段使用。相關切換開關位於 「Settings -> Response Validation Settings」。

啟用後，「Validate Response」功能會在 APIs 模組中的「Request」與「Debug Case」檢視中可用，用於在偵錯階段驗證回應一致性。

啟用後，可在 APIs 模組中的 「Test Cases」 執行「Validate Response」，以在手動測試期間驗證 API 行為。

啟用後，可在 Tests 模組中將「Validate Response」新增為測試步驟，將回應驗證納入完整的自動化測試工作流程。

Apidog 的回應驗證會根據 API 文件中定義的 OpenAPI 規格，自動執行以下檢查：

檢查實際回應的 HTTP 狀態碼是否與文件中定義的狀態碼一致。例如：

文件定義為 200，但實際回傳為 204

文件定義多個可能值（例如 200、201、400、403），並根據允許範圍進行驗證

若不一致，將回報驗證失敗。

根據文件中定義的 Data Schema 驗證以下內容：

欄位是否為必填

欄位的值是否為 null

欄位類型是否正確

必填欄位是否存在

Arrays 與 Objects 的結構是否符合文件

enum 值是否有效

...

這是回應驗證的核心驗證能力。

對於 Object 類型欄位：

如果文件中未設定 additionalProperties，你可以選擇是否允許實際回應包含文件中未定義的額外欄位。

如果已設定 additionalProperties，則會根據文件規則驗證是否允許額外欄位。

此能力允許以寬鬆或嚴格的方式控制回應結構，以適應不同團隊的 API 約束需求。