フローを使用すると、認証トークンの取得、テストデータの設定、テスト終了時のデータクリーンアップなど、よく使用するAPIテストシーケンスを他のAPIテストで再利用するためにカプセル化できます。
この記事では、APIテストエディターでフローを操作する方法について説明します。
ブラウザまたはモバイルテストでのフローに関する情報をお探しですか？mablトレーナーでのフローの操作に関する記事をご覧ください。
新しいフローを作成する
APIテストエディターで新しいフローを作成する方法は2つあります：フローをゼロから作成するか、既存のステップからフローを作成するかです。テストを保存すると、mablは新しいAPIフローをワークスペースに保存します。
ゼロから
フローを追加 > 新しいフローをクリックして、新しいフローを作成します。必要に応じて、フローレベルの認証、カスタムスクリプト、およびパラメータを追加します。その後、ステップを追加するか、既存のステップをテストからドラッグアンドドロップして、フローを開始とフローを終了のステップの間に正しい順序で配置します。
既存のステップから
フローに含めたい各ステップで、ステップ番号にカーソルを合わせ、表示されるチェックボックスをチェックします。フローを作成するには、ステップが連続している必要があります。
上部にあるフローを作成アイコンをクリックします。必要に応じて、フローレベルの認証、カスタムスクリプト、およびパラメータを追加します。
既存のフローをインポートする
APIテストエディターで、[フローを追加] > [既存のフロー]をクリックして、既存のフローをインポートします。
パラメータを使用するフローをインポートした場合、フローパラメータタブでデフォルトのパラメータ値を確認できます。必要に応じて、現在のフローインスタンスに対してオーバーライド値を追加してください。オーバーライドは他のフローインスタンスには影響しません。
フローパラメータを使用する
フローパラメータを使用すると、変数を単一のフローにスコープしたり、異なる変数値でフローを再利用したりできます。フローパラメータを追加するには、フローを編集の鉛筆アイコンをクリックし、フローパラメータタブを開きます。パラメータに名前とデフォルト値を設定します。オーバーライドを指定しない限り、mablはデフォルト値を使用します。
フローにパラメータを追加する
テストステップでフローパラメータを使用するには、パラメータ名の前にflow.を付けます。例えば、フローパラメータtest_varは変数flow.test_varになります。フローパラメータはフロー内のステップでのみ利用可能です。
リクエストでフローパラメータを使用する
異なるシナリオにフローをカスタマイズするには、オーバーライドを追加します。オーバーライドはそのフローのインスタンスにのみ適用されます。
フローを編集する
フローを編集するには、APIテストエディターでフローを含むテストを開きます。必要に応じてステップを修正してください。
フローの編集に関して次の点に注意してください。
- 1つのテストでフローを編集すると、そのフローを使用するすべてのテストでフローが更新されます。
- ワークスペース内で編集者または所有者の役割を持つすべてのユーザーがフローを編集できます。
- フローのバージョンを他のバージョンと分けて保持したい場合は、フローをブランチに保存してください。
APIフローの制限
APIフローではループと条件分岐はサポートされていません。
フローを削除する
APIテストからフローを削除するには、[フローを開始] ステップのごみ箱アイコンをクリックしてください。
ワークスペースからフローを削除するには、テスト > フローに移動し、ゴミ箱アイコンをクリックします。テストで使用されていないフローのみ削除できます。誤ってフローを削除した場合は、削除してから30日以内であればアクティビティフィードから復元できます：ワークスペース> アクティビティフィード。