はじめに
Postmanを利用してAPIにリクエストを送り、そのレスポンスを確認する方法を順を追って簡単にご説明しようと思います。
Postmanとは
APIを開発、テスト、デバッグするためのツールです。開発者やテスターが、RESTful API や GraphQL API へのリクエストを簡単に送信し、レスポンスを確認するために使用されます。
フロントエンドエンジニアも、バックエンドエンジニア(サーバーサイドエンジニア)も必ず一度は利用するツールでしょう！
Postmanにサインアップ or サインイン
Postmanを利用するにはアカウントが必要ですので、(まだ作成していない方は)作成してください。
collectionとRequestの作成
Postmanへのログインが無事成功したら、Workspaceを作成し、Collections -> Blank collectionを作成してください。(ディレクトリを作成するようなイメージです。)
※ collectionには様々な種類がありますが、特に理由がなければBlan collectionでOKです。
collectionを作成したら、Add requestを押下してリクエストを作成してください。(ファイルを作成するようなイメージです。)
リクエストの送信方法
先ほど作成したリクエストを開くと、リクエストの送信方法に関する設定項目を入力できる画面が開きます。
- GETやPUTなど対象のAPIのメソッドを選択
- 対象のAPIのURL(URI + エンドポイント)を入力
- Sendをクリック
↑でリクエスト送信完了です！
あとはそのAPIレスポンスが画面下側にある、Responseセクションに表示されるので確認してみましょう。
リクエストを送信してもエラーが出る場合
Postman Agent を Desktopにダウンロードしてください！(Responseセクションのエラーの内容にこのようなニュアンスの文言が含まれている場合、ダウンロードすれば解決します。)
リクエストの送信方法(オプション)
よく利用するリクエストの各セクションについて簡単に解説しておきます。
しかし、設定内容はAPIによって変わってくるので一概には言えないのですが、大抵のAPIに共通して利用できるような設定内容で解説します。
Params
クエリパラメータのことです。
KeyとValueを入力すれば、APIのURLにクエリパラメータがクエリ文と一緒に自動で挿入されます。
(もちろん直接APIのURLの部分を編集してクエリ文を作成してもOKです。)
Authrization
特に理由がなければ触らなくてOKです。
Headers
特に理由がなければ触らなくてOKです。
Body
- form-data ... POST送信など、リクエストでフォームデータを送信する際に使います
- raw ... JSON形式で利用することが大体だと思われます(直接JSONを記述してリクエストを送信します)
Scripts
特に理由がなければ触らなくてOKです。
Settings
特に理由がなければ触らなくてOKです。
さいごに
Postmanについて全く深掘りした内容でなくて申し訳ないです。(泣)
ですが、以上解説した内容がわかっていれば、必要最低限、業務は遂行できるかと思います。初めてPostmanを利用する人はぜひ参考にしてみてください！
おまけ
APIにGETリクエストを送信する際、通常はParamsでクエリパラメータを設定して送信すると思います。
ですが最近のAPIではRESTfulな設計になっているため、Bodyにraw(JSON)を含めてGETリクエストを送信することができるものもあります。