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

Apidogは、JSON、XML、Raw、MsgPackタイプのリクエストボディに対して複数の例を設定することをサポートしています。この機能は以下の用途に役立ちます：

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

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

例の迅速な切り替え: デバッグや自動テスト時に便利。

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

Apidogのバージョンは2.7.0以上である必要があります。

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

APIドキュメントの編集ページに移動。

リクエストボディセクションを見つける。

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

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

例の名前（任意）: 空白の場合、例1、例2などがデフォルトで設定されます。

例の値（必須）: リクエストボディの実際の例データを提供。

説明（任意）: 例を説明するための説明を追加。Markdown形式でのリッチテキストをサポート。

OAS Key（任意）: OpenAPI仕様をエクスポートする際に使用。指定がない場合、シリアル番号が使用されます。

OAS拡張（カスタムフィールド）: 提供された場合、エクスポート時に保持されます。

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

例を保存すると、使用可能になります。デバッグ中に、異なる例を簡単に選択してAPIをテストできます。

TIP

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

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

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

抽出オプションを選択

リクエストパラメータをどのように保存するかを選択するように求められます：

既存の例を上書き: 以前に保存された例を置き換える。

新しい例: 新しい例として保存。

TIP

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

使用シナリオ

デバッグ中のリクエストボディ例の使用

APIドキュメントの実行ページに移動し、自動生成セクションを見つけます。

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

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

高度な設定

自動生成の横にあるドロップダウンアイコンをクリックして、以下のオプションにアクセスします：

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

送信時に自動生成: モックルールに基づいてランダムな値を自動生成。

自動生成設定: より高度な設定については、リクエストの生成を参照してください。

ドキュメント表示

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

複数のリクエストボディ例の場合: 例の名前とMarkdown説明を表示し、並列レイアウトで例を切り替えることができます。

TIP

リクエストボディ例の表示順序は以下の優先順位に従います：

例の名前 > OAS Key > シリアル番号（1から自動インクリメント）。

非空の項目が最初に表示されます。

OAS準拠

OAS Key

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

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

エクスポートルール:

入力されている場合: 提供されたOAS Keyがオブジェクト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拡張

カスタムOpenAPI 仕様(OAS)拡張を例に追加できます。

設定: OAS拡張フィールドに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`"
    }
}

よくある質問

古いプロジェクトで複数のリクエストボディ例を有効にする方法は？

手動での操作は不要です！既存のAPIに2つ目のリクエストボディ例を追加すると、システムが自動的にフォーマットをアップグレードして複数の例をサポートします。

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

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

エクスポートされた例の名前をよりフレンドリーにする方法は？

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

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

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

使用シナリオ#

デバッグ中のリクエストボディ例の使用#

ドキュメント表示#

OAS準拠#

OAS Key#

OAS拡張#

よくある質問#

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

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

使用シナリオ

デバッグ中のリクエストボディ例の使用

ドキュメント表示

OAS準拠

OAS Key

OAS拡張

よくある質問