本記事は、Postman Flows Blocks の日本語訳です(2024年5月14日更新)。
Postman Flows で利用可能なブロックを以下で説明します。
情報ブロック
Template
大量の書式付きテキストを入力できます。Variables セクションの値は、{{key}}
(key
は変数名)を使ってテキストに含めることができます。
Variables - {{key}}
形式を使用してテキストに含めることができる、名前付きの情報または代入された値。フローで作成された変数は、Post-response スクリプトや Postman Flows 以外の機能では使用できません。
出力 - テキストボックスに入力された情報を次のブロックに送信します。
Get Variable
フロー内の任意の場所から指定された変数の値を取得します。
Create Variable
変数に値を代入し、フロー内の任意の場所で Get Variable ブロックを使ってアクセスできるようにします。入力は任意の値(テキスト、数値、他のブロックからの情報など)です。
Record
他の値ブロック型や別のレコードを保持できる構造化された情報です。情報は、キー(情報に割り当てられた名前)と値を持たせることによって整理されます。
List
特定の値のリストを出力します。各項目は、Date ブロック、String ブロック、Record ブロックなど、どの型のブロックでもかまいません。リストの行で Select ブロックを使用すると、別のブロックからの情報をリストに渡すことができます。
Date & Time
特定の日時を出力します。
Date
特定の日付を出力します。
Now
現在の日時を出力します。
Select
他のブロックから出力された情報の特定の部分を選択します。入力情報が、保存されたサンプルを持つ Send Request ブロックからのものである場合、選択可能なすべての情報を持つドロップダウンがポップアップ表示され、その情報を選択すると、Select ブロックが自動入力されます。
また、Send Request または Output ブロックから出力データをドラッグ&ドロップして Select ブロックを作成することもできます。新しい Select ブロックは、ドラッグ&ドロップしたデータを自動的に選択します。
Regex
正規表現を出力します。
Null
null 値を出力します。
Number
正または負の整数または小数です。
Bool
True か False です。
String
入力したテキストを出力します。
Start
フローの実行時に、最初に実行されるブロックです。クラウドにデプロイする場合、クラウド上で実行するフローは、ローカルでテストするための情報(テキストまたは JSON 形式)を保持するように設定できます。
判定ブロック
If
任意の数の変数と情報を取り、FQL 条件の結果に応じて異なる分岐を取ります。
Variables - 名前の付いた情報または代入された値です。
テキスト入力ブロック - true または false に評価される FQL を使用した自由形式のクエリです。
Data - 別のブロックから情報またはイベントを受け取ります。
出力 - FQL 条件の値に応じて、True または False のいずれかの経路に情報を送信します。
Evaluate
FQL を実行して情報を変更し、変数を操作します。
Variables - FQL を使用してアクセスできる名前付きの情報または代入された値です。
テキスト入力ブロック - FQLを使用した自由形式のクエリです。
出力 - クエリの結果を出力します。
繰り返しブロック
Repeat
Collect ブロックが現れるまで、このブロックの後に続くすべてのブロックを指定された回数実行します。Collect ブロックに到達した場合は、その後に続くブロックを繰り返すことはしません。
Count - ブロックを実行する回数です。
Start - 他のブロックから入力を受け取ったときにブロックを実行します。
Index - 0 から始まる現在の実行の回数です。
For
Collect ブロックが現れるまで、このブロックの後に続くすべてのブロックを、入力リストの各項目につき1回ずつ実行します。Collect ブロックに到達した場合は、その後に続くブロックを繰り返すことはしません。
List - [1,2,3]
や ["one", "two", "three"]
のような値のリストです。
Start - ブロックを実行するための入力を受け取ります。
Item - リスト内の1つの項目を出力します。
Collect
For ブロックと Repeat ブロックは、このブロックに達すると繰り返しを停止します。すべての項目が新しいリストに入れられ、出力されます。
Item - For または Repeat シーケンスから1つの項目を取り込みます。
List - For または Repeat シーケンスでこのブロックに送られたすべての項目のリストを作成します。
Finish - ブロックが完了したとき(すべての項目に対して For または Repeat シーケンスが実行され、すべての項目が新しいリストに入ったとき)にイベントを送信します。
アクションブロック
Send Request
コレクション内のリクエストを実行し、結果を出力します。保存されたサンプルを持つリクエストが使用された場合、フローを実行して Select ブロックを自動入力するためのテストデータとして結果を使用できます。
Select a Request - コレクションとリクエストをここで選択します。
Send - 他のブロックから入力を受け取ると、選択したリクエストが実行されます。
Success - 成功した API リクエストのレスポンスを含みます。リクエストに Postman のテストが割り当てられていて、すべて合格した場合、またはテストがない場合は、2xx(成功)の HTTP ステータスコードを受け取ります。リクエストによって返された情報は、次のブロックに出力されます。
Failure - 失敗した API リクエストのレスポンスを含みます。リクエストに Postman のテストが割り当てられていて、すべて失敗した場合、またはテストがない場合は、2xx 以外(失敗)の HTTP ステータスコードを受け取ります。リクエストによって返された情報は、次のブロックに出力されます。
Create with AI
Create with AI ブロックは、Postman Free、Basic、Professional プランのユーザーが利用できるベータ機能です。
Create with AI ブロックは、GPT-3.5、GPT-4、DALL-E 3 人工知能(AI)モデルを使用して、テキスト、画像、JSON データをフローで生成して出力します。Create with AI ブロックに生成させたい内容を記述したプロンプトを入力し、テストすることができます。
プロンプトで変数を参照するには、中かっこを使用します。例えば、以下のプロンプトには変数が含まれています:
-
{{value1}}
のレスポンスを要約してください。 -
{{body}}
のすべての新規顧客をリストアップしてください。 -
{{expenses}}
のデータを円グラフで可視化してください。
variable - 入力データを変数に代入します。データブロックとしてさらに変数を追加するには、Add data blocks アイコン「+」を選択します。中かっこを使用して、プロンプト内の変数を {{value1}}
のように参照します。
モード選択ドロップダウンリスト - Text、Image、JSON を選択して、作成するデータの種類を指定します。Create with AI ブロックがプロンプトに基づいてデータの種類を自動的に認識するようにするには、Smart を選択します。
テキスト入力ブロック - AI プロンプトをここに入力します。
Test your prompt - Create with AI ブロックの AI から結果またはフィードバックを取得する場合に選択します。
出力 - Create with AI ブロックからデータを送信します。このポートの横のアイコンは、どのモードが選択されているかによって変わります。テキストは Aa、画像は ?、JSONは () と表示されます。
Create with AI ブロックは、他の Postman Flows ブロックよりも多くのクレジットを消費します。詳しくは Manage your team's usage of Postman Flows をご覧ください。
Delay
指定された時間だけ待ってから情報を通します。
Data(入力) - 他のブロックから入力を受け取ると待機を開始します。
Data(出力) - 待機が完了すると、入力された情報を通過させます。
Delay (in ms) - 待機する時間です(ミリ秒)。
出力ブロック
Log (Console)
ブロックに入力された情報を Postman コンソールに送信します。
Output
入力された情報を表示します。ドロップダウンメニューで、JSON、チャート、テーブル、ビデオ、画像などから選択できます。Output ブロックの詳細と例については、Visualizing data を参照してください。