この日のひとつ
Bruno
公式サイトを見る (外部サイト)For Whom
こんな人向け
APIの動作確認手順を、チームでレビュー・再実行できる形にしたい開発者向けです。
The Answer
結論
APIへのリクエストと確認手順を、Gitで管理できるテキストファイルとして残すローカル型のAPIクライアントです。
How to Use
やり方/確認方法
例えば、問い合わせフォームの送信先APIを公開前に確かめる場面に。ローカル環境のURLを対象に、送信内容を最小限にしたPOSTリクエストをBrunoのコレクションへ1件だけ作ります。成功時のステータスと返る項目を確認し、そのリクエストファイルをコードと一緒にGitへ保存します。成果物は、再実行できる確認手順と期待する応答のメモです。最初はダミーデータだけで試し、本番URL・実在の個人情報・認証情報をリポジトリへ入れません。
Why Today
なぜ今日はこれ?
AIにAPI連携を頼むときは、動いた一回のリクエストより、誰でも同じ確認を再現できる形が大切です。リクエストをリポジトリ内のテキストとして差分確認できるBrunoを、実装前後のAPI確認を残す道具として選びます。
Cautions & FAQ
注意点・FAQ
認証情報や環境ごとの秘密値はリポジトリに含めないでください。共有するリクエストは、対象環境と副作用を確認してから実行します。
BrunoのコレクションにはAPI keyもそのまま保存して共有できますか?
秘密情報を共有ファイルへ直接書くのは避けます。環境変数やチームの安全な秘密管理を使い、Gitへ含まれる内容を確認してください。
Primary Sources
公式ソース
Recommended For
誰に持たせたい?
アキト
AI開発推進主任 開発推進室
AI開発推進のアキトに、フォーム連携1件の確認手順を任せたいです。実装コードとは別に、再実行できるリクエストと期待する応答を残せば、修正後の動作確認や引き継ぎを進めやすくなります。
プロフィールを見るKei's Note
ケイのひとこと
ケイ|広報部長
レスポンスが返っただけでは、読者に届く内容まで正しいとは限らないですね。まずはダミーの送信で、画面の案内とAPIの結果が同じ意味になっているかを見たいです。
確かめる。
Basic Information
基本情報
- 種別
- Developer Tool
- 公式サイト
- 公式サイトを開く(外部サイト)
- 確認日
- 料金
- 主要機能は無償で使えるMITライセンスのOSSです。ローカルでのリクエスト作成・保存にアカウントは必要ありません。
- ライセンス
- MIT License
- 補足
- 活用例は公式情報に基づく想定で、実機検証は未実施です。