Postmanの新しい機能であるフローは、ドラッグ＆ドロップすることで、APIワークフローを作成できるビジュアルエディターを指しています。本文では、Postmanのフロー機能に関する基本情報を紹介した上、Postmanフロー機能でAPIワークフローをセットアップしたり、ビルドしたりする方法を皆さんに紹介します。
Postmanのフロー機能とは
Postman Flowsは、Postmanプラットフォーム内のビジュアルツールで、ドラッグ&ドロップインターフェースを使ってAPIワークフローを作成できます。Postman Flowsを利用することで、複雑なAPIリクエストやタスクを自動化し、視覚化してデバッグできるようになります。
上記の画像のように、Postmanのフロー機能を使うことで、直感的なエディターでは、複数のAPIエンドポイントを連結し、実際の業務に従って、APIのワークフローを作成することができます。Postmanのフローでは、ブロックというものを使ってAPIリクエストのチェーンを構成したり、レスポンスを視覚化にしたりしています。
Postmanフローの使い方
それでは、Postmanのフロー機能を利用して、APIワークフローを作成するために、どうしたらいいですか？次は、Postmanフローのセットアップ方法を皆さんに紹介します。
Postmanのインストール
まずは、Postmanをパソコンにダウンロードしてインストールする必要があります。まだインストールしていない場合は、Postmanの公式サイトから最新のバージョンをダウンロードしましょう。
Postmanフローを作成する
そして、Postmanを開き、「New」→「Flow」の順にクリックすることで、Postmanフローを作成し始めることができます。
APIワークフローをビルドするためにリクエストを追加
APIリクエストをフローに追加するために、「Add blocks」をクリックして、「Send Request」を選択しましょう。ここでHTTPメソッド(GET, POST, PUT, DELETE)、エンドポイントURL、ヘッダー、BodyデータなどのAPIリクエストの詳細を定義することができます。
リクエストチェーンを作成する
Postman Flowsで複数のリクエストをつなげて実行できる点は非常に強力な機能です。その一例として、以下のようなユースケースが考えられます。
- ある APIエンドポイントからユーザーリストを取得する
- 取得したユーザーそれぞれの詳細情報を別のエンドポイントから取得する
このようなワークフローを実現するには、以下の手順を踏みます。
- キャンバスに「Request」ブロックをドラッグ&ドロップし、ユーザーリストを取得するエンドポイントを設定する
- さらに別の「Request」ブロックをドラッグ&ドロップし、最初のブロックにつなげる
- 2つ目のブロックでは、1つ目のレスポンスからユーザーIDなどを取得し、そのユーザーの詳細を取得するエンドポイントを設定する
このようにして、最初のリクエストが完了した後に、2つ目のリクエストが自動的に実行されるよう連鎖させることができます。複数のAPIリソースからデータを取得する必要がある場合に、このようなリクエストチェーンは非常に便利です。
条件分岐のロジックを組み込む
「Condition」ブロックを使うことで、前のリクエストのレスポンスに基づいて次の処理を分岐させることができます。例えば以下のようなケースが考えられます。
- レスポンスステータスコードが200 OKの場合は次のリクエストを実行し、それ以外はエラー処理に進む
- レスポンス本文にある特定の値が期待値と一致する場合は次の処理に進み、不一致の場合は別の処理を行う
- レスポンスヘッダーから取得した値に基づいて、異なるエンドポイントに対してリクエストを送信する
このように、条件ブロックを使うことで、APIレスポンスに応じて、より細かくワークフローを制御できます。単に一方向にリクエストを連ねるのではなく、条件に応じて分岐させたり、異なる処理を実行したりできます。
変数を利用する
Postman変数を利用することは、Postman Flowsでよりダイナミックなワークフローを構築する上で非常に重要です。変数を上手く活用することで、ワークフロー内の値を動的に制御できるようになります。毎回固定値を入力するのではなく、前のレスポンスから値を取得したり、環境に合わせて値を変更したりできます。
Postman Flowsでは変数の割り当て、変数の参照が視覚的にできるので、コーディングなしでも変数の管理が容易にできます。ダイナミックかつ柔軟性の高いワークフローを実現するには、変数の適切な利用が重要なポイントになります。
Apidog：APIワークフローをより便利に作成する
APIワークフローを作成するために、Postmanのフロー機能を利用することは非常に便利なオプションになりますが、Apidogの自動テストを利用することで、APIワークフローをより簡単に行うことが可能です。
Apidogでは、リクエストをテストケースとして保存し、再利用性が高くなり、テストシナリオを作成してAPIのワークフローを視覚的に構築することが可能です。
上記のように、Apidogを利用して、APIワークフローを作成するために、ステップを簡単に追加した後、これらのステップをグループ化にしたり、条件分岐やループのロジックを組み込んだりするなど、豊富なオプションを利用できます。
まとめ
本記事では、Postmanの新機能であるフロー機能について詳しく解説しました。Postmanのフロー機能を活用することで、視覚的なインターフェースでAPIワークフローを作成でき、複雑なリクエストの自動化やデバッグが容易になります。
Postmanのフロー機能は非常に役立つ機能ですが、Apidog自動テストを活用することで、より便利にAPIワークフローを構築できます。リクエストをテストケースとして保存し、シナリオとしてグループ化できるため、視覚的でわかりやすいワークフロー作成が可能になります。
APIワークフローの自動化は開発の効率化につながるため、Postmanのフロー機能やApidogの自動テストなどのツールを上手く活用していくことが重要です。
