はじめに
Postmanではコードを生成してくれるAIコンパニオンの Postbot が2023年7月にベータ版としてリリースされました。
ベータ版のため、まだまだ不安定な部分もありますが、テスト生成やレスポンスの視覚化など工数の多い作業を代行してくれるため、生産性UPに役立ちそうです。
Postbotの使い方
個人プランを使用している場合は、何もせずとも使用できます。
APIを開いてTestsタブを開くと右にあるボタンからPostbotのウィンドウが開けます。
開いたウィンドウにChatGPTのようにプロンプトを入力することで、Postbotを使うことができます。デフォルトでいくつかのプロンプトが用意されており、それを使うことで機能を試すこともできます。
Postmanは英語しかサポートしておらず、用意されているサンプルのプロンプトも英語です。しかし、Postbotに使用されているAIは日本語にも対応しているようで、プロンプトを日本語で書いても一応は理解します。(英語に比べると結果が不安定です)
テストの生成を支援
Postbotはテストの生成に便利です。テスト生成のプロンプトを入力すると、AIが実際にAPIを叩いて、リクエストやレスポンスなどの情報を得ることで必要なテストを作成します。完璧なテストではないですが、生成されたテストを修正するだけである程度の品質は担保できるので工数の削減には十分です。
Postbotでテストを生成するには「Add tests to this request」をクリックし右上の実行ボタンを押すだけです。
テストが生成されると自動でAPIを実行します。
生成されたコードはTestsタブに記述されます。テストの実行結果はレスポンスのTest Resultsで見ることができます。
もし追加のテストが必要なら「Add more tests」をクリックすればプロンプトが追加され、更にコードが生成されます。
コレクションのテストをまとめて生成
コレクション内のAPIのテストをまとめて生成することもできます。
コレクションの右の3点リーダーをクリックし、BETA版のGenerate testsを押下します。
テストが生成されると一覧が表示されます。右上の「Generate Tests」をクリックすることですべてのテストが実行され、結果が表示されます。
レスポンスを可視化
Postmanにはレスポンスを視覚化するVisualizerという機能が存在します。
HTMLでテンプレートを用意し、レスポンスデータを入れることでグラフや表のような形にレンダリングすることができます。
Postman | Visualizing responses
Postbotを利用することでレスポンスを容易に視覚化することができます。
やり方はテストの生成と同じで、プロンプトのサンプルの「Visualize response...」を選択するだけです。次に表示される「...as table」「...as line chart」「...as bar graph」で表・折れ線グラフ・棒グラフを選択することも可能です。
画像は気温の取得するAPIを「Visualize response as line chart」で視覚化した結果です。