テストステップ間でデータを渡す方法

自動テストのシナリオでは、複数のリクエスト間でデータを渡すことは非常に一般的です。典型的なケースには次のようなものがあります。

リクエスト 1 がログインリクエストでトークンを返し、リクエスト 2 がこのトークンを使用して他のデータをリクエストする場合。

リクエスト 1 が ID を返し、リクエスト 2 がこの ID に基づいて操作を実行する場合。

リクエスト 1 がリストを返し、リクエスト 2 がこのリスト内のデータを使用する場合。

このようなシナリオに対して、Apidog はリクエスト間のデータ受け渡しを処理するための 2 つの異なるソリューションを提供しています。具体的な問題に応じて適切なソリューションを選択できます。

前ステップデータを取得: この機能を使用すると、後続のリクエストで先行するリクエストのデータを直接使用できます。

利点は、追加の変数を導入する必要がなく、シンプルであることです。

ただし、データを複数回参照する必要がある場合は、やや煩雑になることがあります。

前ステップデータを取得機能は、「Tests」モジュールでのみ使用でき、「APIs」モジュールでは使用できません。

変数を使用: 先行するリクエストのプリプロセッサに「Extract Variables」を追加して必要なデータを変数に保存し、後続のリクエストでこの変数を呼び出します。

利点は、データを複数回参照する場合に便利であることですが、単一の参照ではやや複雑になる場合があります。

変数は「Tests」モジュールと「APIs」モジュールの両方で使用できます。

前ステップデータを取得

リクエスト 1 がログインリクエストでトークンを返し、リクエスト 2 がこのトークンを使用して追加データをリクエストするシナリオを考えてみましょう。

ログインリクエスト（リクエスト 1）をテストシナリオに追加します。

クエリリクエスト（リクエスト 2）をテストシナリオに追加します。

リクエスト 2 のクエリパラメータには、リクエスト 1 が返したトークンを含める必要があります。リクエスト 2 のクエリパラメータ内のトークンフィールドで「魔法の杖」アイコン 🪄 をクリックし、「Retrieve pre-step data」を選択します。

データ取得対象としてリクエスト 1 を選択し、レスポンスボディを選択して、JSONPath を使用してリクエスト 1 が返したトークンを抽出します。例: $.token。

Insert をクリックすると、クエリパラメータとして {{$.2.response.body.token}} が挿入されます。

テストシナリオで「Run」ボタンをクリックすると、リクエスト 1 からリクエスト 2 へデータを正常に渡すことができます。

「Retrieve pre-step data」機能は、「Tests」モジュールでのみ使用可能であり、「APIs」モジュールでは使用できません。

「Retrieve pre-step data」を使用する場合、値はテストシナリオ全体をまとめて実行した場合にのみ取得できます。個別のステップを実行した場合にはアクセスできません。

前述の {{$.2.response.body.token}} の例を使用します。

「2」はステップ ID を表し、各テストステップで確認できます。

「response.body」は、前ステップから取得するデータの位置を示します。これには、リクエストのヘッダー、ボディ、またはレスポンスのヘッダーやボディなどのデータを含めることができます。詳細は以下を参照してください。

「token」は、ボディ内の次の階層にある「token」データを表します。JSONPath 構文を使用して目的のデータを抽出できます。

前ステップデータは、リクエストパラメータ、ヘッダー、認証など、リクエストのさまざまな部分で利用できます。また、以下に示すように、リクエストボディにデータを直接挿入することもできます。

スクリプト内で前ステップデータを使用する必要がある場合、{{variable}} 構文を使用して変数を直接参照することはできない点に注意してください。代わりに、pm.variables.get を使用して前ステップデータを参照する必要があります。例:

カテゴリ	機能	構文例
リクエスト	URL	{{$.<step id>.request.url}}
	パスパラメータ	{{$.<step id>.request.pathParam.<field name>}}
	クエリ	{{$.<step id>.request.query.<field name>}}
	ヘッダー	{{$.<step id>.request.header.<field name>}}
	ボディ（form）	{{$.<step id>.request.body.<field name>}}
	ボディ（json）	{{$.<step id>.request.body.<field path>}}
レスポンス	ボディ	{{$.<step id>.response.body.<field path>}}
	ヘッダー	{{$.<step id>.response.header.<field name>}}
	Cookie	{{$.<step id>.response.cookie.<field name>}}
ループ	要素（ForEach ループ内の配列要素）	{{$.<loop step id>.element.<field path>}}
ループ	インデックス	{{$.<loop step id>.index}}

ログインリクエスト（リクエスト 1）をテストシナリオに追加します。

リクエスト 1 のポストプロセッサで、「Extract Variable」アクションを追加し、$.token を {{token}} として抽出します。

Extract variable の詳細をご確認ください。

クエリリクエスト（リクエスト 2）をテストシナリオに追加します。

リクエスト 2 のクエリパラメータで変数 {{token}} を参照します。

テストシナリオで「Run」ボタンをクリックすると、リクエスト 1 からリクエスト 2 へデータを正常に渡すことができます。