テストシナリオにフロー制御条件（ループ、条件、待機、グループ化など）を追加できます。これにより、より複雑なテストシナリオ／プロセス構成を活用でき、最終的に自動テスト機能によって複雑なシナリオのテスト課題を解決できます。For ループ#
単一のリクエストを連続して複数回送信する必要がある場合、for ループを使用するのが効率的な方法です。Apidog のテストシナリオで For ループを効果的に使用する方法は次のとおりです。反復回数の設定: ループを何回実行するかを決定します。固定値または {{variable}} を指定できます。
リクエストの追加: For ループ内には、1 つ以上のリクエストのほか、他のループや条件分岐を含めることができます。この柔軟性により、複数のアクションを順番にテストする必要がある複雑なテストシナリオを作成できます。
Break If 条件: For ループに Break if 条件を追加できます。条件が満たされると、ループは直ちに終了します。Break if の位置をドラッグして調整したり、複数の Break if 条件を追加してさまざまなシナリオに対応したりできます。
On Error 処理: ループに On Error 条件を追加してエラーを管理します。エラーが発生した場合、指定されたアクションがトリガーされます。Ignore: ループは次のリクエストへ進みます。
Continue: 現在のサイクル内の残りのリクエストをスキップし、次の反復へ進みます。
Break execution: ループを停止し、ループ外の後続リクエストへ進みます。
End execution: テストシナリオ全体を完全に停止します。
On Error 条件はループの先頭に固定されており、移動できません。
リクエストでループインデックスを使用する#
ループの現在のインデックスは、リクエスト内のローカル変数として使用でき、パラメータやリクエストボディを動的に調整できます。使用するには、次の手順に従います。1
For ループを追加し、ループ内にリクエストを含めます。
2
リクエストパラメータで魔法の杖アイコン
🪄 をクリックし、「Retrieve pre-step data」を選択します。
「Retrieve pre-step data」機能は「Tests」モジュールでのみ利用でき、「APIs」モジュールでは利用できません。
「Retrieve pre-step data」を使用する場合、値はテストシナリオ全体をまとめて実行したときにのみ取得できます。個別のステップを実行する場合はアクセスできません。
3
通常「Loop n times」と表示されるループオプションを選択します。
4
「Current loop index」を選択します。
5
{{$.5.index}} のような動的変数を取得できます。「Insert」をクリックすると、実行時に現在のループのインデックス（
0 や
5 など）に置き換えられます。
ForEach ループ#
複数の要素を含む配列（特定のコンテンツのリスト、または前のステップから取得したリスト）があり、そのリスト内の各項目に対して同じ操作を実行する必要がある場合（例: まず商品リストを取得し、その後リスト内の各商品をショッピングカートに追加する場合）、ForEach ループを使用する必要があります。ForEach ループでは、ループ内の操作が配列内の各要素に対して実行されます。For ループとの違いは、反復回数を気にする必要がなく、ループ配列の内容にのみ注目すればよい点です。ループ配列の設定: ForEach ループでは、配列をループ対 象として設定する必要があります。変数を使用することも、["a","b","c"] のように配列を手動で入力することもできます。
リクエストの追加: ForEach ループ内には、1 つ以上のリクエストを追加したり、他のループや条件分岐などを追加したりできます。
Break If 条件と On Error 処理: ForEach ループには、上記の For ループと同様に Break if と On error を追加できます。
ForEach ループの詳細 設定では、Break If と On Error の例外処理オプションもカスタマイズできます。詳細については、判定ルールを参照してください。
ForEach の使用例#
ペット情報のリストを取得するエンドポイントと、単一のペットの詳細を取得するエンドポイントの 2 つを考えます。リストに最近追加されたペットの詳細を取得する必要がある場合、自動テストで ForEach ループを使用してこのシナリオを設定できます。1.
ForEach ループの外側の最初のステップでは、ペット情報リストのエンドポイントにリクエストして実際のリストデータを取得します。通常、このインターフェースのレスポンスには、ペット ID や名前など、複数のペットに関する基本情報を含む配列が含まれます。
2.
前のステップのレスポンスから得られたペット配列のサブセットをソース配列として、ForEach ループを設定します。
3.
ループ内で「Get Pet Information」エンドポイントへのリクエストを設定し、ForEach ループの要素値を使用して、このリクエストの ID パラメータを入力します。
リクエストでループ要素を使用する#
ループの現在の要素／インデックスは、リクエスト内のローカル変数として使用でき、パラメータやリクエストボディを動的に調整できます。使用するには、次の手順に従います。1
ForEach ループを追加し、ループ内にリクエストを含めます。
2
リクエストパラメータで
魔法の杖 アイコンをクリックし、「Retrieve pre-step data」を選択します。
3
通常「Loop each element in
{{array}}」と表示されるループオプションを選択します。
4
「Current loop element」を選択します。JSONPath を使用して要素のプロパティを抽出できます。
5
{{$.17.element}} のような動的変数を取得できます。「Insert」をクリックすると、実行時に現在のループの要素、つまりループ配列の要素に置き換えられます。
Current Loop Element: システムは ForEach ループで指定された配列から要素を自動的に抽出し、指定された変数に保存します。各反復の開始時に、この変数は配列内の現在の要素の値で更新されます。要素がオブジェクトの場合、JSONPath を使用して {{$.1.element.data.name}} のように特定のサブフィールドを抽出できます。Current Loop Index: 現在のループのインデックスがこの変数に保存されます。0 から始まり、以降の各反復の開始時に 1 ずつ増加し、現在のインデックスを反映します。
If 文の設定: If 文は、等しい、等しくない、含む、含まないなど、さまざまな条件をサポートします。条件の両側には、定数と変数のどちらも使用できます。
リクエストの追加: 条件分岐内には、複数のリクエストのほか、他のループや条件分岐を追加できます。
条件分岐の実行: 設定で指定された条件が満たされると、テストステップが実行されます。満たされない場合はスキップされます。
Else 文: If 条件が満たされないシナリオに対応するため、条件分岐内に Else 文を追加できます。
If の使用例#
ペットショップのオーナーが、前日のペットの販売状況に基づいて、販売されたペットの販売ステータスを「Sold」に変更する必要があるとします。それ以外の場合（else）は、まだ販売中のペット一覧を確認する必要があります。1.
下部の「Add Step」ボタンをクリックし、「Conditional Branching」を選択します。
2.
API リクエストのレスポンスから取得した変数 saleStatus を「If」の後の入力ボックスに入力し、条件「equals」を選択します。最後に、比較値として true を入力します。
3.
条件分岐操作にカーソルを合わせると、「 + Else」オプションが表示されます。これをクリックして「List of Pets for Sale」ステップを追加します（条件が満たされない場合、つまりまだ販売中のペット一覧を照会する場合）。
判定ルール#
テストシナリオで If 文を使用する場合、テスト実行を制御する条件ルールを定義できます。条件が満たされると、対応するステップが実行されます。満たされない場合はスキップされます。同様に、ForEach および For ループの Break If 設定でも、判定ルールを設定して実行フローをより柔軟に制御できます。| ルール | 説明 |
|---|
| Equals | 2 つの値が等しいかどうかを確認します。 |
| Does not equal | 2 つの値が等しくないかどうかを確認します。 |
| Exists | フィールドまたは変数が存在す るかどうかを確認します。 |
| Does not exist | フィールドまたは変数が存在しないかどうかを確認します。 |
| Less than | ある値が別の値より小さいかどうかを確認します。 |
| Less than or equal | ある値が別の値以下であるかどうかを確認します。 |
| Greater than | ある値が別の値より大きいかどうかを確認します。 |
| Greater than or equal | ある値が別の値以上であるかどうかを確認します。 |
| Matches with Regex | 文字列が指定された正規表現に一致するかどうかを確認します。 |
| Contains | 文字列または配列に指定された値が含まれているかどうかを確認します。 |
| Does not contain | 文字列または配列に指定された値が含まれていないかどうかを確認します。 |
| Is empty | フィールド、配列、または変数が空であるかどうかを確認します。 |
| Is not Empty | フィールド、配列、または変数が空でないかどうかを確認します。 |
| In List | 値が指定されたリストに属しているかどうかを確認します。 |
| Not in List | 値が指定されたリストに属していないかどうかを確認します。 |
条件チェック（大なり、大なりイコール、等しい、等しくないなど）を実行する際、比較対象の値が整数または文字列の場合、システムは正確な比較のために 文字列を数値へ自動的に変換 します。たとえば、文字列 "18" と数値 18 を比較する場合、システムは比較前に文字列 "18" を数値 18 に変換します。Equals#
2 つの値が等しいかどうかを確認します。等しい場合、条件が満たされ、テストステップが実行されます 。等しくない場合はスキップされます。シナリオ: 前のステップから抽出したユーザーの年齢が 18 に等しいかどうかを確認します。
条件例: {{$.5.response.body.data.age}} Equals 18
実際の実行効果: 前のステップから抽出した年齢値が 18 の場合（文字列は自動的に数値に変換されます）、特定の情報を表示する、または特定のアクションを実行するなど、そのステップが実行されます。
Does not equal#
2 つの値が等しくないかどうかを確認します。等しくない場合、条件が満たされ、テストステップが実行されます。等しい場合はスキップされます。シナリオ: 前のステップから抽出した注文ステータスが「Paid」と等しくないかどうかを確認します。
条件例: {{$.4.response.body.data.status}} Does not equal Paid
実際の実行効果: 前のステップから抽出した注文ステータスが別の値（「Pending」や「Shipped」など）の場合、そのステップが実行されます。
Exists#
特定のフィールドまたは変数が存在するかどうかを確認します。存在する場合、条件が満たされ、ステップが実行されます。存在しない場合はスキップされます。シナリオ: 前のステップから抽出したユーザーデータに email フィールドが存在するかどうかを確認します。
条件例: {{$.3.response.body.data.email}} Exists
実際の実行効果: 前のステップから抽出したユーザーデータに email フィールドが存在する場合、そのステップが実行されます。
Does not exist#
特定のフィールドまたは変数が存在しないかどうかを確認します。存在しない場合、条件が満たされ、ステップが実行されます。存在する場合はスキップされます。シナリオ: 前のステップから抽出したユーザーデータに phone フィールドが存在しないかどうかを確認します。
条件例: {{$.2.response.body.data.phone}} Does not exist
実際の実行効果: 前のステップから抽出したユーザーデータに phone フィールドが存在しない場合、そのステップが実行されます。
Less Than#
ある値が別の値より小さいかどうかを確認します。小さい場合、条件が満たされ、ステップが実行されます。小さくない場合はスキップされます。シナリオ: 前のステップから抽出した商品の在庫数が 10 未満であるかどうかを確認します。
条件例: {{$.1.response.body.data.stock}} Less Than 10
実際の実行効果: 前のステップから抽出した在庫値が 8 の場合、条件が満たされ、ステップが実行されます。
Less than or equal#
ある値が別の値以下であるかどうかを確認します。以下である場合、条件が満たされ、ステップが実行されます。そうでない場合はスキップされます。シナリオ: 前のステップから抽出した年齢が 12 以下であるかどうかを確認します。
条件例: {{$.2.response.body.data.age}} Less than or equal 12
実際の実行効果: 前のステップ から抽出した年齢値が 10 の場合、条件が満たされ、ステップが実行されます。
Greater than#
ある値が別の値より大きいかどうかを確認します。大きい場合、条件が満たされ、ステップが実行されます。大きくない場合はスキップされます。シナリオ: 前のステップから抽出した注文金額が 1000 より大きいかどうかを確認します。
条件例: {{$.1.response.body.data.amount}} Greater than 1000
実際の実行効果: 前のステップから抽出した注文金額の値が 1105 の場合、条件が満たされ、ステップが実行されます。
Greater than or equal#
ある値が別の値以上であるかどうかを確認します。以上である場合、条件が満たされ、ステップが実行されます。そうでない場合はスキップされます。シナリオ: 前のステップから抽出したユーザーポイントが 500 以上であるかどうかを確認します。
条件例: {{$.3.response.body.data.points}} Greater than or equal 500
実際の実行効果: 前のステップから抽出したポイントの値が 600 の場合、条件が満たされ、ステップが実行されます。
Matches with Regex#
文字列が指定された正規表現に一致するかどうかを確認します。一致する場合、条件が満たされ、ステップが実行されます。一致しない場合はスキップされます。シナリオ: 前のステップから抽出したメール形式が正しいかどうかを確認します。
条件例: {{$.2.response.body.data.email}} Matches with Regex /^[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,}$/i
実際の実行効果: 前のステップから抽出したメール形式が正規表現に一致する場合（例: test@gmail.com）、ステップが実行されます。
正規表現は「リテラル」構文で記述する必要があります。つまり、パターンを / で囲み、任意の修飾子（例: グローバルマッチングの g、大文字／小文字を区別しない i）を末尾に追加します。正規表現の記述方法の詳細については、MDN ドキュメントを参照してください。 Contains#
文字列または配列に指定された値が含まれているかどうかを確認します。含まれている場合、条件が満たされ、ステップが実行されます。含まれていない場合はスキップされます。シナリオ: 前のステップから抽出したユーザーロールリストに「admin」ロールが含まれているかどうかを確認します。
条件例: {{$.3.response.body.data.roles}} Contains admin
実際の実行効果: 前のステップから抽出したロールリストに「admin」が含まれている場合、そのステップが実行されます。
Does not contain#
文字列または配列に指定された値が含まれていないかどうかを確認します。含まれていない場合、条件が満たされ、ステップが実行されます。含まれている場合はスキップされます。シナリオ: 前のステップから抽出したユーザーのショッピングカートに特定の商品が含まれていないかどうかを確認します。
条件例: {{$.4.response.body.data.cartItems}} Does not contain productId123
実際の実行効果: 前のステップから抽出したカート配列に商品 productId123 が含まれていない場合、そのステップが実行されます。
Is empty#
フィールド、配列、または変数が空であるかどうかを確認します。空である場合、条件が満たされ、ステップが実行されます。空でない場合はスキップされます。シナリオ: 前のステップから抽出した備考フィールドが空であるかどうかを確認します。
条件例: {{$.2.response.body.data.remarks}} Is empty
実際の実行効果: 前のステップから抽出した備考フィールドが空の場合、そのステップが実行されます。
Is not Empty#
フィールド、配列、または変数が空でないかどうかを確認します。空でない場合、条件が満たされ、ステップが実行されます。空の場合はスキップされます。シナリオ: 前のステップから抽出した注文備考が入力されているかどうかを確認します。
条件例: {{$.1.response.body.data.orderRemarks}} Is not Empty
実際の実行効果: 前のステップから抽出した注文備考が空でない場合、そのステップが実行されます。
In List#
値が指定されたリストに属しているかどうかを確認します。属している場合、条件が満たされ、ステップが実行されます。属していない場合はスキップされます。シナリオ: 前のステップから抽出した、ユーザーが選択した商品が推奨商品リストに含まれているかどうかを確認します。
条件例: {{$.3.response.body.data.productId}} In List ["prod123", "prod456", "prod789"]
実際の実行効果: 前のステップから抽出した商品 ID が「prod456」の場合、そのステップが実行されます。
Apidog でリストを入力する場合、各要素は個別に入力し、Enter キーを押して区切る必要があります。
Not in List#
値が指定されたリストに属していないかどうかを確認します。属していない場合、条件が満たされ、ステップが実行されます。属している場合はスキップされます。シナリオ: 前のステップから抽出した、ユーザーが入力したプロモーションコードが使用済 みプロモーションコードのリストに含まれていないかどうかを確認します。
条件例: {{$.4.response.body.data.promoCode}} Not in List ["usedCode1", "usedCode2"]
実際の実行効果: 前のステップから抽出したプロモーションコードが「newPromo」の場合、条件が満たされ、ステップが実行されます。そうでない場合はスキップされます。
グループ化#
テストプロセス内の複数のステップが相互に関連している場合、それらをグループ化して分類できます。テストステップをグループ化することで、テストシナリオの可読性と操作性が向上します。テストプロセス内の特定のステップで、実行前に一定時間待機する必要がある場合、待機条件を追加してこれを解決できます。待機の使用例#
ユーザーがペットの詳細を閲覧し、1000ms 閲覧した後にペット情報の閲覧ステータスを更新する操作をシミュレートします。1.
下部の「Add Step」ボタンをクリックし、「Wait」を選択します。
2.
待機する時間として 1000（ミリ秒単位）を入力します。
テストフロー制御を使用する場合、テストレポートには If、for などのステップは表示されず、実際に実行されたリクエストのみが実行順に線形で表示されます。
