Postmanを使って郵便番号から住所を取得してみる

5352 ワード
Postman api api テキストリンク

はじめに

みなさんPostmanは知ってますか？
郵便配達じゃなくて、WebAPIのツールです。
WebAPIを勉強しようと思ったときに、便利なツールがあるということでまずはPostmanを触れてみようと思います。

今回はGETメソッドを使って〠郵便番号を取得してみましょう。

Postmanとは


Postman(ポストマン)はPostman社が提供しているAPI開発用のコラボレーションプラットフォーム。APIを開発する作業を簡素化してくれて、作業効率を向上してくれます。

リクエストから認証、テストなどの機能が搭載されていてAPI開発をスピーディーに行えるようになります。

Postmanの機能

Postmanの大まかな機能は6種類あります。

  • API Client
    公開されているもしくは開発中のAPIをテストできる機能

  • Autimated Testing
    マニュアルテストを自動化してCI/CDパイプラインに統合する

  • Design & Mock
    バックエンドサーバーを設置せずにエンドポイントとレスポンスをシュミレート

  • Documantation
    自動的にAPIドキュメントを生成して公開できる機能

  • Monitors
    APIのアップデートや変更に伴う破損や変化がないかをモニタリングする

  • Workspaces
    チームでAPIを共同開発するための機能

Postmanのインストール

PostmanはWebアプリケーションとしても使うことができますが、ダウンロードして使うこともできます。

Postmanダウンロードページ

インストールするとサインアップを求めらるのでメールアドレスなどを入力してサインアップします。

ログインするとホーム画面が表示されます。

Create Newをクリックしてください。

それでは郵便番号から住所を取得していきましょう。

今回はzipcloudという郵便番号配信サービスを使ってJSONを取得してみます。
zipcloud

リクエストURLのhttps://zipcloud.ibsnet.co.jp/api/searchを貼り付けます。

ここに郵便番号を入力するだけでも検索することができます。

https://zipcloud.ibsnet.co.jp/api/search?zipcode=郵便番号

とURLの後にパラメータ名と検索したい郵便番号を入力してみましょう。

入力するとわかるかと思いますがKEYとVALUEが自動で入力されます。
逆にVALUEを変更するとURLの値も自動で変わります。

郵便番号で住所は取得できましたでしょうか？
こんな感じでPostmanは簡単にしかも、見やすくAPIを試すことができます。

便利な機能はたくさんありますが今回はここら辺で。


参考サイト
- Zenn 圧倒的業務効率化！Postman の便利な使い方
- XLSOFT BLOG RESTサービスを触る際の必須ツールPostmanを使ってみました
- IT業務で使えるプログラミングテクニック Postmanを使ったAPIテストのやり方