リクエストの生成

リクエストパラメータの生成#

Design-first Mode

Request-first Mode

Apidog の Design-first Mode では、Edit タブでエンドポイントを指定した後、Run タブをクリックしてリクエスト送信インターフェースに切り替えることができます。ここでは、定義したエンドポイント仕様に基づいて、対応するリクエストが自動的に生成されます。

path パラメータ、query パラメータ、headers、および form-data または x-www-form-urlencoded タイプの body について、エンドポイント仕様で example を指定している場合、この例は Run インターフェースの value フィールドに初期リクエストパラメータ値として自動的に入力されます。

TIP

endpoint specification のパラメータ名、説明、タイプ、例などのパラメータが Edit タブで変更され保存されると、Run タブの対応するフィールドもそれに応じて更新されます。仕様で行われた変更は開発プロセス全体に反映され、一貫性と正確性が維持されます。

リクエストボディの生成#

リクエストボディの例と初期コンテンツ#

Design-first Mode

Request-first Mode

エンドポイント仕様に定義済みのボディ例が含まれている場合、この例は Run タブに初期ボディコンテンツとして表示されます。

エンドポイント仕様にボディ例が定義されていない場合、Run タブのボディフィールドは空白のままになります。ただし、Auto-generate をクリックすると、要件に合ったボディ構造を作成できます。

自動生成オプション#

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

1. Examples#

2. Generate Each Time#

3. Auto-Generation Preference#

Use Example Values First

機能: リクエストデータスキーマに例の値が定義されている場合、それらが自動生成に使用されます。例の値が設定されていない場合は、Mock ルールに基づいてランダムな値が生成されます。

ユースケース: 一部のフィールドには固定値が必要で、他のフィールドは動的に生成できるシナリオに最適です。

Use Default Values First

機能: リクエストデータスキーマにデフォルト値が定義されている場合、それらが自動生成に使用されます。デフォルト値が設定されていない場合は、Mock ルールに基づいてランダムな値が生成されます。

ユースケース: プリセット値を保持する必要があるデバッグシナリオに適しています。

Use Mock Value

機能: Smart Mock ルールに基づいてデータを生成します。

ユースケース: 完全なテストデータをすばやく生成します。

Generate Field Names Only

機能: リクエストデータスキーマを使用してフィールド名のみを生成し、値は空白のままにします。

ユースケース: 特定の値を手動で入力する必要があるテストシナリオに役立ちます。

Use Request Example

機能: 定義済みのリクエスト例をランダムに選択します。

ユースケース: 通常リクエストや例外リクエストなど、異なるビジネスシナリオをすばやく切り替えます。

動的値の挿入#

リクエストの送信#