リクエスト間でデータを渡す

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

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

リクエスト1がIDを返し、リクエスト2がそのIDに基づいて操作を行う。

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

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

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

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

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

前ステップのデータ取得機能は「自動テスト」モジュールでのみ使用可能で、「API管理」モジュールでは使用できません。

変数を使用する: 前のリクエストの前処理で「変数を抽出」を追加し、必要なデータを変数に保存し、後続のリクエストでこの変数を呼び出します。

利点は、データを複数回参照する場合に便利ですが、単一の参照の場合には少し複雑になる可能性があります。

変数は「自動テスト」モジュールと「API管理」モジュールの両方で使用できます。

前ステップのデータを取得する

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

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

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

リクエスト2のクエリパラメータには、リクエスト1が返したトークンを含める必要があります。リクエスト2のクエリパラメータのトークンフィールドにある「魔法の杖」アイコン 🪄 をクリックし、「前ステップのデータを取得」を選択します。

データ取得のためにリクエスト1を選択し、レスポンスボディを選択し、JSONPathを使用してリクエスト1が返したトークンを抽出します。例えば $.token のようにします。

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

テストシナリオの「実行」ボタンをクリックして、リクエスト1からリクエスト2へのデータ受け渡しを成功させます。

「前ステップのデータを取得」機能は「自動テスト」モジュールでのみ使用可能で、「API管理」モジュールでは使用できません。

「前ステップのデータを取得」を使用する場合、値はテストシナリオ全体を一緒に実行した場合にのみ取得可能で、個別のステップを実行した場合にはアクセスできません。

変数構文を使用して前ステップのデータを参照する

前のテキストの {{$.2.response.body.token}} の例を使用します：

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

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

'token' はボディ内の次のレベルの 'token' データを表します。JSONPath構文を使用して目的のデータを抽出できます。

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

スクリプト内で前ステップのデータを使用する必要がある場合、{{variable}} 構文を使用して変数を直接参照することはできません。代わりに、pm.variables.get を使用して前ステップのデータを参照する必要があります。例えば：

構文リファレンス

カテゴリ	機能	構文例
リクエスト	URL	{{$.<ステップID>.request.url}}
	パスパラメータ	{{$.<ステップID>.request.pathParam.<フィールド名>}}
	クエリ	{{$.<ステップID>.request.query.<フィールド名>}}
	ヘッダー	{{$.<ステップID>.request.header.<フィールド名>}}
	ボディ（フォーム）	{{$.<ステップID>.request.body.<フィールド名>}}
	ボディ（JSON）	{{$.<ステップID>.request.body.<フィールドパス>}}
レスポンス	ボディ	{{$.<ステップID>.response.body.<フィールドパス>}}
	ヘッダー	{{$.<ステップID>.response.header.<フィールド名>}}
	Cookie	{{$.<ステップID>.response.cookie.<フィールド名>}}
ループ	要素（ForEachループ内の配列要素）	{{$.<ループステップID>.element.<フィールドパス>}}
ループ	インデックス	{{$.<ループステップID>.index}}

変数を使用してデータを受け渡す

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

リクエスト1の後処理で、「変数を抽出」アクションを追加し、$.token を {{token}} として抽出します。

変数を抽出について詳しく学ぶ。

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

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

テストシナリオの「実行」ボタンをクリックして、リクエスト1からリクエスト2へのデータ受け渡しを成功させます。

FAQ

Q: なぜ前ステップのデータを正常に参照できないのですか？

A: まず、現在「自動テスト」モジュールにいることを確認してください。「前ステップのデータを参照」機能は「自動テスト」モジュールでのみ使用可能で、「API管理」モジュールでは使用できません。

「自動テスト」モジュールにいることを確認したら、「実際のリクエスト」タブに切り替えて、リクエスト内で参照されている前ステップのデータが正常に組み込まれているか確認してください。

実際のリクエスト内の参照が {{$.n.response.body.abc}} のまま表示され、実際のデータが表示されていない場合、参照が適用されていないことを示しています。

この場合、以下の一般的な理由を考慮してください：

単一のステップではなく、テストシナリオ全体を実行しましたか？前ステップのデータを参照するには、テストシナリオ全体を実行する必要があります。

ステップIDが正しく、参照したいステップに対応しているか確認してください。

使用したJSONPathがデータソースと正確に一致していることを確認してください。

リクエスト間でデータを渡す

前ステップのデータを取得する#

変数構文を使用して前ステップのデータを参照する#

構文リファレンス#

変数を使用してデータを受け渡す#

FAQ#

前ステップのデータを取得する

変数構文を使用して前ステップのデータを参照する

構文リファレンス

変数を使用してデータを受け渡す

FAQ