契約テストは、実際のレスポンスがAPIドキュメントで定義された仕様（OpenAPI仕様書）に適合しているかを検証する手法です。ステータスコードやレスポンス構造などの内容に一貫性チェックを行うことで、開発・デバッグ・テストの各段階で実装とドキュメントの不整合を早期に発見し、サービス間のAPI挙動を安定かつ信頼できるものにします。Apidogのレスポンス検証（契約テスト）はAPIドキュメントと深く統合されており、APIリクエスト、デバッグケース、テストケース、自動テストのステップで利用できます。基盤機能として標準で有効になっています。レスポンス検証の有効化#
レス ポンス検証はモジュール単位で有効化でき、業務ニーズに応じて各段階で使用できます。関連する切り替え設定は「設定→レスポンス検証の設定」にあります。APIリクエストとデバッグケース#
有効化すると、API管理モジュール内の「リクエスト」と「デバッグケース」ビューで「レスポンス検証」を利用でき、デバッグ段階でのレスポンス整合性を確認できます。テストケース#
有効化すると、API管理モジュールの「テストケース」で「レスポンス検証」を実行し、手動テスト時にAPIの挙動を検証できます。自動テストのステップ#
有効化すると、自動テストモジュールで「レスポンス検証」をテストステップとして追加でき、レスポンス検証を自動化フロー全体に組み込めます。レスポンス内容の検証#
Apidogのレスポンス検証は、APIドキュメントで定義されたOpenAPI仕様書に基づき、以下のチェックを自動で実行します。レスポンスのHTTPステータスコードの検証#
ドキュメントで定義されたステータスコードと実際のレスポンスのコードが一致するかを確認します。例：ドキュメントでは200だが、実際は204を返している
ドキュメントが複数の可能な値（例：200、201、400、403）を定義している場合、その許容範囲内かを検証
レスポンスボディのデータモデル検証#
ドキュメントで定義されたデータモデルに基づき、次の内容を検証します。オブジェクトにおける追加プロパティの制御#
オブジェクト型のフィールドに対しては、次のとおり制御できます。ドキュメントで「additionalProperties」が未設定の場合、ドキュメントにない余分なフィールドを実際のレスポンスに含めることを許容 するかどうかを選択できます。
「additionalProperties」が設定されている場合は、ドキュメントのルールに従って余分なフィールドの許容可否を検証します。
Modified at 2025-11-19 10:01:30
