複数のリクエストボディ例を設定する

Apidog は、JSON、XML、Raw、MsgPack タイプのリクエストボディに対して、複数の例を設定することをサポートしています。この機能は、次のような場合に便利です。

異なるビジネスシナリオの例を設定する: たとえば、通常のリクエストと例外リクエストなどです。

OAS 3.0/3.1 仕様への準拠: 標準の OpenAPI 仕様のエクスポートをサポートします。

例をすばやく切り替える: デバッグや自動テスト中に便利です。

複数のリクエストボディ例を設定する

Apidog バージョン 2.7.0 以降が必要です。

新しいリクエストボディ例を作成する

エンドポイントドキュメントの Edit ページに移動します。

Request Body セクションを見つけます。

+ Add ボタンをクリックして、新しいリクエストボディ例を作成します。

リクエストボディ例を設定する

Example Name（任意）: 空白のままにすると、デフォルトで Example 1、Example 2 などになります。

Example Value（必須）: リクエストボディの実際のサンプルデータを指定します。

Description（任意）: 例を説明する説明文を追加します。リッチテキスト用の Markdown 書式をサポートしています。

OAS Key（任意）: OpenAPI 仕様をエクスポートする際に使用されます。指定しない場合は、代わりに連番が使用されます。

OAS Extensions（カスタムフィールド）: 指定した場合、エクスポート時に保持されます。

リクエストボディ例を保存して使用する

例を保存すると、使用できるようになります。デバッグ中に、異なる例を簡単に選択してエンドポイントをテストできます。

TIP

Raw タイプのリクエストボディでは、デバッグ中に最初の例の値のみが表示されます。

リクエストパラメータを例として抽出する

デバッグ中にリクエストボディを手動で設定し、それを例として保存したい場合は、Extract > Extract to "Request Example" をクリックするだけです。

抽出オプションを選択する

リクエストパラメータを保存する方法を選択するよう求められます。

Overwrite the Example: 以前に保存した例を置き換えます。

New Example: 新しい例として保存します。

TIP

現在のデバッグ値は、デフォルトで例に自動入力されます。

使用シナリオ

デバッグ中にリクエストボディ例を使用する

エンドポイントドキュメントの Run ページに移動し、Auto-generate セクションを見つけます。

ドロップダウンメニューをクリックして、リクエストボディ例を選択します。例が自動的に入力されます。

例をリアルタイムで切り替え、選択した例でリクエストを送信できます。

詳細設定

Auto-generate の横にあるドロップダウンアイコンをクリックすると、次のオプションにアクセスできます。

EXAMPLES: 事前定義されたリクエストボディ例から選択します。

Generate Each Time: mock rules に基づいてランダム値を自動生成します。

Auto-generation Preference: より高度な設定については、Generate Requests を参照してください。

ドキュメント表示

単一のリクエストボディ例の場合: 例の名前を表示せず、簡略化されたビューで表示されます。

複数のリクエストボディ例の場合: 横並びレイアウトで例を切り替えられ、例の名前と Markdown の説明が表示されます。

表示順序

リクエストボディ例の表示順序は、次の優先順位に従います。

Example Name > OAS Key > Serial Number（1 から自動増分）。

空でない項目が先に表示されます。

OAS 準拠

OAS Key

OAS キーは、OpenAPI 仕様をエクスポートする際の examples のフィールド名を制御します。

設定: リクエストボディ例に OAS Key を入力します。

エクスポートルール:

入力されている場合: 指定された OAS キーが、オブジェクト examples 内のフィールド名として使用されます。

入力されていない場合: 1 から始まる連番が、フィールド名として自動的に使用されます。

入力されている場合

入力されていない場合:

 "examples": {
   "example1": {
      "value": {
        "name": "Blake Keeling",
        "id": "165061",
        "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    },
    "example2": {
       "value": {
        "name": "Jolie Kutch",
        "id": "138164",
        "email": "Jolie_Kutch@hotmail.com"
      },
      "summary": "example 2",
      "description": "This is`example 2`"
    }
  }

"examples": {
   "1": {
     "value": {
       "name": "Blake Keeling",
       "id": "165061",
       "email": "Blake.Keeling@gmail.com"
     },
     "summary": "example1",
     "description": "This is`example 1`"
   },
    "2": {
      "value": {
       "name": "Jolie Kutch",
       "id": "138164",
       "email": "Jolie_Kutch@hotmail.com"
     },
     "summary": "example 2",
     "description": "This is`example 2`"
   }
 }

OAS Extensions

例にカスタム OpenAPI Specification（OAS）拡張を追加できます。

設定: OAS Extension フィールドに JSON のキーと値のペアを入力します。

{
  "x-demo": true,
  "x-scenario": "error_case"
}

エクスポート結果: カスタム OAS 拡張は完全に保持され、エクスポートされた OpenAPI 仕様に含まれます。

"examples": {
    "example1": {
      "x-demo": true,
      "x-scenario": "error_case",
      "value": {
         "name": "Blake Keeling",
         "id": "165061",
         "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    }
}

FAQs

古いプロジェクトで複数のリクエストボディ例を有効にするにはどうすればよいですか？

手動操作は必要ありません。既存のエンドポイントに 2 つ目のリクエストボディ例を追加すると、システムが複数の例をサポートする形式へ自動的にアップグレードします。

OAS をエクスポートする際、複数のリクエストボディ例はどのように処理されますか？

エクスポートされた OAS でリクエストボディ例の順序は変わりますか？

エクスポートされる例の名前をより分かりやすくするにはどうすればよいですか？

複数のリクエストボディ例を設定する

複数のリクエストボディ例を設定する#

リクエストパラメータを例として抽出する#

使用シナリオ#

デバッグ中にリクエストボディ例を使用する#

ドキュメント表示#

OAS 準拠#

OAS Key#

OAS Extensions#

FAQs#

複数のリクエストボディ例を設定する

リクエストパラメータを例として抽出する

使用シナリオ

デバッグ中にリクエストボディ例を使用する

ドキュメント表示

OAS 準拠

OAS Key

OAS Extensions

FAQs