このような疑問をお持ちの方に向けて書いています。
PostmanはAPIからのレスポンスを事前に確認できるため、開発で重宝します。
▼この記事では、以下の点を理解できます。
- Postmanとは
- Postmanのインストール・ダウンロード
- Postmanの使い方
実際の開発現場でもPostmanを使う人はいるので、使い方を覚えておくと今後役立つでしょう。
使い方は簡単なので、ざっと目を通してみてください。
Postmanとは？
Postmanとは何か簡単に紹介していきます。
PostmanはWebAPIクライアントサービス
Postmanは、WebAPIクライアントサービスといわれリクエストを送信し、Responseを受け取るためのツールです。PostmanのWeb版へアクセスしてみてください。
Postmanはどんな時に使うのか
Postmanは、APIの開発をしている時に正しく動作しているか確認する時に使用することが多いです。特に呼び出し側（画面）が未実装の時に使用すると重宝します。
WebAPIクライアントは他にもある
Talend API Tester - Free EditionといったChromeの拡張機能に追加して使うツールもあります。
アプリをダウンロードしたくない、拡張機能使いたくないなど好みで使うといいと思います。
Postmanのインストール・ダウンロード
実際にインストールをして準備していきましょう。
Postmanのアカウント作成
画面右上から「Sign Up for Free」をクリックしてアカウントを作成します。上記の画像の画面へ遷移できます。メールアドレスかGoogleアカウントで認証してください。
よくサイトがアップデートされるので、注意してください。画面は2021/12月現在のものです。
PostmanのMac用アプリダウンロード
アプリ版のダウンロードは画面左上のProduct->「Get started free」から可能です。
以下から自分の環境に合った方を選択してください。
ダウンロードしたあとは、解凍すると使えます。次は実際に使ってみましょう。
Postmanの使い方
実際にPostmanを使ってみます。
New requestでAPIをたたく準備
Add a requestをクリックすると、実際にAPIをたたく画面になります。
JSONを返してくれるAPIサービスJSONPlaceholderを利用する
APIの実装まですると面倒なので、JSONPlaceholderというサービスを利用します。決まったURLにリクエストを送ると適当なJSONデータを返してくれます。
このURLhttps://jsonplaceholder.typicode.com/postsにアクセスすると、以下のようなJsonを返却してくれます。
PostmanでAPIをたたいてみる
GETの場合は、URLの左側からGETを選択しURLを入力して送信をクリック。レスポンスが下の方に表示されています。しっかりと実行できていますね。
いろんなリクエストが可能
上ではGETの使い方を紹介しましたが、POST、PATCH、DELETEなども使うことが可能です。
例えば、認証の場合はPOSTを選択して、Header情報にAuthorization入力して認証のAPIを確認するといったこともできます。
Postmanの使い方まとめ
今回はWebAPIクライアントのPostmanがどのようなツールかを紹介しました。
APIの開発をすることが多いWeb開発では、重宝すると思うので使ってみてください。