API開発ツールPostmanを導入してAPIを使用する方法
当ブログでは、オンライン学習サービス「CodeCamp」をおすすめしています。
CodeCampは、株式会社コードキャンプが提供しているオンライン学習サービスです。
利用するメリットとして、マンツーマン指導や転職支援があることが挙げられます。
また、今なら無料でカウンセリングが受講でき、受講料1万円割引クーポンが貰えます。
独学に限界を感じている方や、就職・転職やキャリアに悩んでいる方は相談してみてはいかがでしょうか？
ぜひ一度カウンセリングを受講してみてください。この機会をお見逃しなく！
実行環境
| OS | macOS Catalina 10.15.7 |
| Google Chrome | 90.0.4430.93 |
API開発ツールPostmanを導入する方法
今回は、API開発ツールである「Postman」を導入する方法を2つご紹介します。
また、導入した後にサンプルのAPIを用いてPostmanでのAPIの使用方法をご紹介します。
Postmanを導入する方法は以下のとおりです。
- Google Chromeの拡張機能を使用する
- アプリケーションをインストールする
- ブラウザ版を使用する ※アカウント作成が必要な為割愛
Google Chromeの拡張機能を使用する
PostmanをGoogle Chromeの拡張機能を使用して導入する手順は以下のとおりです。
- Chrome ウェブストアからPostmanを追加する
- Postmanを起動する
- 動作を確認する
Chrome ウェブストアからPostmanを追加する
- Chrome ウェブストアの「Postman」にアクセス
- [Chromeに追加] ボタンを押下
- [アプリを追加] ボタンを押下
ヒント
Chrome ウェブストアの検索でPostmanが表示されない場合、以下からアクセス可能です。
https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=ja
Postmanを起動する
- ChromeでChromeアプリ（chrome://apps/）にアクセス
- Postmanを押下
- 「Take me straight to the app. I’ll create an account another time.」を押下
- アプリケーションのインストールを促すポップアップが出たら × ボタンを押下
以下のように表示されていたらPostmanの起動完了です。
アプリケーションをインストールする
Postmanをアプリケーションをインストールして導入する手順は以下のとおりです。
- Postmanのウェブサイトからインストーラをダウンロードする
- Postmanを起動する
- 動作を確認する
Postmanのウェブサイトからインストーラをダウンロードする
- Postmanのウェブサイトにある ダウンロードページ にアクセス
- [Download the App] ボタンを押下
Postmanを起動する
- インストーラを起動してPostmanをインストール
- Postmanアプリケーションを起動
- 「Skip and go to the app」を押下
以下のように表示されていたらPostmanの導入完了です。
PostmanでAPIを使用する方法
PostmanでAPIを使用する方法は以下のとおりです。
- コレクションを作成する
- リクエストを作成する
- リクエストを送信してレスポンスを確認する
コレクションを作成する
はじめに、リクエストをグループ化する機能であるコレクションを作成します。
今回は、「New Collection」というデフォルトの名前でコレクションを作成します。
- 左ペインの＋アイコンまたは「Create Collection」リンクを押下
以下のように表示されていたらコレクションの追加完了です。
リクエストを作成する
次に、リクエストを作成します。
APIとして指定した郵便番号の住所を返却する「郵便番号検索API（zipcloud）」を使用させていただきます。
郵便番号検索APIとは
郵便番号検索APIは、日本郵便が公開している郵便番号データを検索する機能をRESTで提供しています。
ベースとなるURLは以下になります。
https://zipcloud.ibsnet.co.jp/api/search
このURLにリクエストパラメータを加え、リクエストを行います。（例）郵便番号「7830060」で検索する場合
郵便番号検索API（zipcloud）
https://zipcloud.ibsnet.co.jp/api/search?zipcode=7830060
- コレクションのメニューアイコンを押下
- 「Add request」を押下
- リクエスト名を「郵便番号検索API」に変更
- URL入力欄に「https://zipcloud.ibsnet.co.jp/api/search?zipcode=7830060」を入力
- [Save] ボタンを押下
以下のように表示されていたらリクエストの追加完了です。
リクエストを送信してレスポンスを確認する
最後に、リクエストを送信してレスポンスを確認します。
- [Send] ボタンを押下
- レスポンスを確認
ヒント
日本郵便のウェブサイトの「郵便番号から該当地域を検索する」から検索するとレスポンスと同内容が表示されます。
お疲れさまでした
API開発ツールPostmanを導入してAPIを使用する方法ご紹介しました。
少しでも参考になれば幸いです。
どんな記事が読みたいですか？
現在、ミルラクでは記事に関するアンケートを実施しています。
ご回答いただいた内容は今後の記事の役立てていきますので、ぜひご回答ください！