変数を使用すると、動的な値をアサートし、レスポンス間の値を比較して、ランダム値を生成し、データ駆動型テストを行い、動的データを扱う必要のあるシナリオに対応することができます。
この記事では、APIテストエディターで変数を使用する方法について説明します。内容は次のとおりです。
レスポンスから変数を作成する方法
APIステップのレスポンスから変数を作成するには、次の手順を実行します。
- ステップビルダーで、[バリデーションと変数代入] セクションを展開します。
- [変数] タブを選択します。
- [Add] ボタンをクリックします。
- 変数の説明を入力します。
- 変数のターゲットを選択します。"Header" を選択した場合は、ヘッダーキーを入力します。"JSON body" の場合は、ターゲットレスポンスプロパティへのJSONパスを入力します。
- [変数へ割り当て] 入力フィールドで、変数の名前を指定します。
レスポンスボディからの変数の作成
リクエストを再度送信すると、左側の [変数] パネルにこの変数が表示されます。変数は連続するテストステップで使用したり、同じテストプラン内の後続のテストと共有したりすることができます。
共有変数のプレースホルダーを追加する方法
APIテストがプラン内の前のテストから共有変数を継承する場合、プレースホルダーの値を使ってデータ駆動型変数を作成します。
- 編集者の下部にある変数パネルで、プラス記号をクリックして新しい変数を追加します。
- 変数名を入力します。
- 変数のデフォルト値を指定します。
ローカル実行とアドホック実行では、変数でデフォルト値が使用されます。プラン実行では、共有変数の条件が一致している場合、共有変数の値によってデフォルト値がオーバーライドされます。
ランダムに生成された値を使って変数を作成する方法
APIテストではmabl変数構文 ({{@variable_name}}) を使用できますが、その他の有効な式 (マクロ、faker値、数式) はサポートされません。ただし、APIテストでは、mablとPostmanとのインテグレーションにより、Postmanの動的変数がサポートされます。
リクエストでのPostmanの動的変数の使用
変数を使用する方法
リクエストまたはレスポンスの検証でmabl変数構文を使用して変数を参照します。
たとえば、次のリクエストでは、変数existing_user_idは{{@existing_user_id}}になります。
次のアサーションでは、レスポンスの値がDataTableのシナリオの値と一致していることを検証します。DataTable変数first_nameは{{@first_name}}になります。
変数を使用した期待される値のアサーション