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
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. APIのテスト
  • Apidog ラーニングセンター
  • はじめに
    • Apidog の概要
    • Apidog の基本概念
    • Apidog のナビゲーション
    • クイックスタート
      • 概要
      • エンドポイントの作成
      • リクエストの作成
      • アサーションの追加
      • テストシナリオの作成
      • APIドキュメントの共有
      • さらに詳しく
    • Apidogへの移行
      • 概要
      • 手動インポート
      • スケジュールインポート(データソースのバインド)
      • インポートオプション
      • データのエクスポート
      • インポート元
        • Postman からのインポート
        • OpenAPI 仕様のインポート
        • cURL のインポート
        • Markdown のインポート
        • Insomnia からインポート
        • apiDoc からインポート
        • .har ファイルをインポート
        • WSDL のインポート
  • モックAPIデータ
    • 概要
    • Smart Mock
    • カスタムモック
    • モック優先順位
    • モックスクリプト
    • Cloud Mock
    • セルフホスト Runner モック
    • モック言語(ロケール)
  • アカウントと設定
    • アカウント設定
    • OpenAPI アクセストークンの生成
    • 通知
    • 言語設定
    • ホットキー
    • ネットワークプロキシ設定
    • データのバックアップ
    • Apidog の更新
    • アカウントの削除
    • 実験的機能
  • リクエスト送信
    • 概要
    • SSE デバッグ
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP または WebService
    • GraphQL
    • gRPC
    • デバッグにリクエストプロキシエージェントを使用する
    • リクエスト作成
      • リクエスト履歴
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • リクエストのデバッグ
      • リクエストをエンドポイントとして保存する
      • HTTP/2
    • 認証と認可
      • 概要
      • CA 証明書とクライアント証明書
      • 認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 認証
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとCookie
      • APIレスポンスの表示
      • Cookie の管理
      • 概要
  • APIの開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • デバッグケース
    • テストケース
    • 動的値
    • レスポンスの検証
    • Design-First と Request-First
    • コード生成
    • 環境と変数
      • 概要
      • 変数の使用
      • 環境管理
    • Vaultシークレット
      • 概要
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 動的値モジュール
      • Airline
      • Animal
      • Color
      • Commerce
      • 会社
      • Database
      • データ型
      • 日付
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • 画像
      • Internet
      • Location
      • Lorem
      • 音楽
      • Number
      • Person
      • Phone
      • Science
      • 文字列
      • システム
      • Vehicle
      • Word
    • プリプロセッサとポストプロセッサ
      • 概要
      • アサーション
      • 変数の抽出
      • Wait
      • セキュリティ
      • データベース操作
        • 概要
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • スクリプトの使用
        • 概要
        • プリプロセッサスクリプト
        • ポストプロセッサスクリプト
        • Public Scripts
        • Postman Scripts Reference
        • 他のプログラミング言語の呼び出し
        • JS ライブラリの使用
        • レスポンスの可視化
        • スクリプト例
          • アサーションスクリプト
          • 変数の使用
          • リクエストの変更
          • その他の例
    • APIデバッグ
      • AI Agent Debugger
      • A2A Debugger
  • API設計
    • 概要
    • 新しい API プロジェクトを作成する
    • エンドポイントの基本
    • API設計ガイドライン
    • モジュール
    • 複数のリクエストボディ例を設定する
    • コンポーネント
    • 共通フィールド
    • グローバルパラメータ
    • エンドポイント変更履歴
    • コメント
    • エンドポイントの一括管理
    • カスタムプロトコル API
    • Spec-first Mode(ベータ)
    • セキュリティスキーム
      • 概要
      • セキュリティスキームを作成する
      • セキュリティスキームを使用する
      • オンラインドキュメントにおけるセキュリティスキーム
    • 高度な機能
      • カスタムエンドポイントフィールド
      • 関連するテストシナリオ
      • エンドポイントステータス
      • パラメータ一覧の表示形式
      • エンドポイントの一意識別
    • スキーマ
      • 概要
      • 新しいスキーマを作成する
      • スキーマを構築する
      • JSON などからスキーマを生成
      • oneOf、allOf、anyOf
      • Discriminator の使用
  • APIテスト
    • 概要
    • テストシナリオ
      • テストシナリオを作成する
      • リクエスト間でデータを受け渡す
      • フロー制御条件
      • エンドポイントおよびエンドポイントケースからデータを同期する
      • 他のプロジェクトからエンドポイントとエンドポイントケースをインポートする
      • テストシナリオのエクスポート
    • テストレポート
      • テストレポート
    • テストシナリオの実行
      • テストシナリオを実行する
      • テストシナリオを一括実行する
      • データ駆動テスト
      • 共有テストデータ
      • スケジュールされたタスク
      • 他のプロジェクトの API の実行環境を管理する
    • テストスイート
      • 概要
      • テストスイートを作成する
      • テストスイートを編成する
      • テストスイートをローカルで実行する
      • CLI でテストスイートを実行する
      • スケジュールタスク
    • APIのテスト
      • 統合テスト
      • パフォーマンステスト
      • エンドツーエンドテスト
      • 回帰テスト
      • コントラクトテスト
    • Apidog CLI
      • 概要
      • Apidog CLI のインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Github Actions との連携
      • Gitlab との統合
      • Jenkins との連携
      • Git コミットによるテストのトリガー
  • APIドキュメントの公開
    • 概要
    • サポートされているAPI技術
    • クイック共有
    • API ドキュメントの閲覧
    • Markdown ドキュメント
    • ドキュメントサイトの公開
    • カスタムログインページ
    • カスタムレイアウト
    • カスタム CSS、JavaScript、HTML
    • カスタムドメイン
    • AI 機能
    • SEO 設定
    • 詳細設定
      • ドキュメント検索
      • CORS プロキシ
      • Google Analytics の連携
      • フォルダツリー設定
      • 表示設定
      • ドキュメントURLへの値の埋め込み
    • APIバージョン
      • 概要
      • API バージョンの作成
      • API バージョンの公開
      • API バージョンを指定したエンドポイントの共有
  • ブランチ
    • 概要
    • スプリントブランチの作成
    • ブランチでAPIをテストする
    • ブランチで API を設計する
    • スプリントブランチのマージ
    • スプリントブランチの管理
    • AI Branch(ベータ)
  • AI機能
    • 概要
    • AI機能の有効化
    • テストケースの生成
    • AI によるスキーマの変更
    • エンドポイントコンプライアンスチェック
    • APIドキュメント完全性チェック
    • AIを活用したフィールド命名
    • FAQ
  • Apidog MCPサーバー
    • 概要
    • Apidog プロジェクトを AI に接続する
    • 公開済みドキュメントを AI に接続する
    • OpenAPI ファイルを AI に接続する
  • ベストプラクティス
    • API署名の処理
    • OAuth 2.0 で保護された API へのアクセス
    • コラボレーションワークフロー
    • 認証状態の管理
  • オフラインスペース
    • 概要
  • 管理
    • プロジェクト管理
      • プロジェクトの管理
      • 通知設定
      • プロジェクトメンバーの管理
      • プロジェクトリソース
        • データベース接続
        • Git 接続
    • チーム管理
      • チームの管理
      • チームメンバーの管理
      • チームアクティビティ
      • チームのロールと権限
      • チームリソース
        • General Runner
        • チーム変数
        • リクエストプロキシエージェント
      • リアルタイムコラボレーション
        • チームコラボレーション
    • オンボーディングチェックリスト
      • 基本概念
      • オンボーディングガイド
    • 組織管理
      • 組織の管理
      • 組織ロールと権限
      • プラン管理
        • 組織の請求管理者
      • シングルサインオン(SSO)
        • SSO 概要
        • Microsoft Entra ID の設定
        • Okta の設定
        • 組織の SSO を設定する
        • ユーザーアカウントの管理
        • グループをチームにマッピングする
      • SCIMプロビジョニング
        • SCIM プロビジョニングの概要
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホスト Runner
  • 請求
    • 概要
    • クレジット
    • プランのアップグレード
    • 代替支払い方法
    • サブスクリプションの管理
    • 有料チームの組織への移動
  • Apidog Europe
    • Apidog Europe
  • アドオン
    • API Hub
    • Apidog Intellij IDEA プラグイン
    • ブラウザ拡張機能
      • Chrome
      • Microsoft Edge
    • リクエストプロキシ
      • Web でのリクエストプロキシ
      • 共有ドキュメントにおけるリクエストプロキシ
      • クライアントでのリクエストプロキシ
  • データとセキュリティ
    • データストレージとセキュリティ
    • ユーザーデータのプライバシーとセキュリティ
    • リクエストルーティングとデータセキュリティ
  • リファレンス
    • APIデザインファーストアプローチ
    • Apidog OpenAPI 仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSON Schema
    • CSVファイル形式
    • Java 環境のインストール
    • Runner デプロイ環境
    • Apidog Markdown 構文
    • Apidog Swagger拡張
      • 概要
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema拡張
      • 概要
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • サポートセンター
  1. APIのテスト

コントラクトテスト

コントラクトテストは、実際のAPIレスポンスがAPIドキュメント(OpenAPI)で定義された仕様に準拠しているかどうかを検証するために使用されます。ステータスコードやレスポンス構造などの内容について整合性チェックを実行することで、開発、デバッグ、テストの各フェーズにおいて、実装とドキュメント間の不整合を適時に発見でき、サービス間で安定した信頼性の高いAPI動作を確保できます。
Apidogのレスポンス検証(コントラクトテスト)機能は、APIドキュメントと深く統合されています。これは、APIリクエスト、デバッグケース、テストケース、および自動化テストステップで使用できます。デフォルトで有効化されている基盤機能です。

レスポンス検証を有効にする#

レスポンス検証はモジュールごとに有効化でき、ビジネスニーズに基づいてさまざまな段階で使用できます。関連するトグルは、**「Settings -> Response Validation Settings」**にあります。
CleanShot 2025-11-18 at 17.27.01@2x.png

APIリクエストとデバッグケース#

有効にすると、APIsモジュール内の「Request」および「Debug Case」ビューで「Validate Response」機能を利用でき、デバッグフェーズでレスポンスの整合性を検証するために使用されます。
CleanShot 2025-11-18 at 17.31.18@2x.png

テストケース#

有効にすると、APIsモジュール内の**「Test Cases」**で「Validate Response」を実行でき、手動テスト中にAPIの動作を検証できます。
CleanShot 2025-11-18 at 17.39.22@2x.png

自動化テストステップ#

有効にすると、Testsモジュールで「Validate Response」をテストステップとして追加でき、レスポンス検証を完全な自動テストワークフローに組み込めます。
CleanShot 2025-11-18 at 17.41.39@2x.png

レスポンス内容を検証する#

Apidogのレスポンス検証は、APIドキュメントで定義されたOpenAPI仕様に基づいて、以下のチェックを自動的に実行します。

レスポンスのHTTPステータスコードを検証する#

実際のレスポンスのHTTPステータスコードが、ドキュメントで定義されたステータスコードと一致しているかどうかをチェックします。例:
ドキュメントでは200が定義されているが、実際の戻り値は204である
ドキュメントで複数の可能な値(例:200、201、400、403)が定義されており、許可された範囲に対して検証する
一致しない場合、検証失敗が報告されます。
CleanShot 2025-11-18 at 17.45.17@2x.png
CleanShot 2025-11-18 at 17.45.56@2x.png

レスポンスボディのスキーマを検証する#

ドキュメントで定義されたデータスキーマに基づいて、以下の内容を検証します。
フィールドが必須かどうか
フィールドの値がnullかどうか
フィールドの型が正しいかどうか
必須フィールドが存在するかどうか
配列およびオブジェクトの構造がドキュメントに準拠しているかどうか
enum値が有効かどうか
...
これはレスポンス検証の中核となる検証機能です。
CleanShot 2025-11-18 at 17.49.17@2x.png

オブジェクト内の追加プロパティの制御#

Object型フィールドについて:
ドキュメントでadditionalPropertiesが設定されていない場合、実際のレスポンスにドキュメントで定義されていない追加フィールドを含めることを許可するかどうかを選択できます。
additionalPropertiesが設定されている場合、ドキュメントのルールに従って追加フィールドの許可を検証します。
この機能により、さまざまなチームのAPI制約要件に適応するために、レスポンス構造を緩やかに制御することも、厳密に制御することもできます。
CleanShot 2025-11-18 at 17.50.39@2x.png
CleanShot 2025-11-18 at 17.51.17@2x.png
Modified at 2026-06-11 07:06:02
Previous
回帰テスト
Next
概要
Built with