はじめに
皆さんこんにちは。
エンジニアの細川です!
今月のSIOS Technologyのアドベントカレンダー、テーマは「生成AI」ということで、Postmanの様々な機能をサポートしてくれるAIエージェントのPostbotについて紹介したいと思います!
Postmanとは?
Postman皆さんもきっとよく使ってますよね?
説明するまでもないかもしれませんが、Postmanは主にAPIをテストするために様々な機能を提供してくれるツールになります。
APIにリクエストを投げる際、curlコマンドなどを叩かなくても、GUIですぐにリクエストを投げることができます。
クエリパラメータやbodyの値なども含めてrequestを保存することができ、環境ごとにtokenを切り替えたり、テストを自動化したりなど、非常に機能が豊富なツールになります。
僕も普段から大変お世話になっております…
Postbotとは
Postmanは非常に機能が豊富ですが、その豊富な機能を使う際にサポートしてくれるAIエージェントのPostbotという機能があります。
なんとこちら無料で使うことができます!
早速使ってみましょう!
Postmanを開いて以下の画像の場所をクリックしてみてください!
デスクトップアプリでも、ブラウザでも利用することができます。
上記の場所をクリックするとチャット画面が開きます。
後はChatGPTなどのように、自然言語で様々なお願いをすることができます。
日本語でお願いすると日本語で返してくれます!
(絶賛開発中のようで、たまに、英語で返ってきたりもあります…)
ドキュメント生成
では少し実践的に使ってみましょう!
まずはリクエストからドキュメントを生成してくれます。
リクエストを開いた状態でPostbotに「このリクエストのドキュメントを書いて」とお願いしてみました。
すると、以下のようにマークダウンでドキュメントを書いてくれます!
これは、Azure OpenAIServiceのDALL-Eにリクエストを投げる際の例になります(DALL-Eの詳しいリクエストの投げ方はこちら)。
RequesyBodyやヘッダー、クエリパラメータなどがある少し複雑なリクエストですが、一瞬でマークダウンのドキュメントを作成してくれました。
現在はドキュメントは英語のみの出力のようですが、リクエストからドキュメントを一瞬で作ってくれるのは非常に便利かと思います!
テストコード自動生成
続いて、テストコードを書く際にサポートしてもらおうと思います。
ご存知の方も多いと思いますが、Postmanではリクエストごとにテストコードを記述することができ、自動実行もすることができます。先ほどのDALL-Eのリクエストのテストを書いてもらおうと思います。
リクエストを開いた状態で、Postbotに「このリクエストのテストを書いて」とお願いしてみました。すると以下のように一般的によく使われるテストケースでテストを自動で書いてくれます!
また、テストケースを編集・追加したい場合などはもちろんエディター部分で直接変更することができます。さらに!テストの説明分まで書いた時点で以下のようにサジェストしてくれる機能がついています!
いたれり尽くせりですね!
その他の機能
今回紹介した以外にも質問に関連したPostmanのドキュメントのURLを教えてくれたり、エラーが起こった場合の原因の推測など幅広い用途に活用することができます!
Postmanで困ったことがあればとりあえずPostbotに聞いてみるのが良さそうです!
まとめ
- Postbotは無料で利用可能!
- ドキュメント生成
- テスト自動生成(サジェストも)
- その他諸々サポート!
おわりに
今回はPostbotについて紹介させていただきました。
Postman自体非常に便利で、普段から大変お世話になっていますが、このPostbotを利用することで今まで以上にPostmanを使いこなせそうな気がします。
今月は生成AIがテーマということで、他にも生成AIに関連したブログ記事がたくさん出るはずですので、皆さんぜひ読んでみてください!
参考
今回はネット上で公開してくださっているこちらの資料を参考にさせていただきました!