postmanでREST APIを弄る

今更感満載ながらREST APIをpostmanで弄ってみようと思う。

まずはpostmanをダウンロード
https://www.getpostman.com/

Chromeのアドオンもあるらしいが、今回はアプリを落としてみた。

インストールは特に詰まることもないと思うので特に記載しない。
アカウント作成を求められるが、作っておいたほうがいろんなロケーションで作ったリクエストが流用できて便利。

さて起動。

REST APIってのはざっくりいうとhttpと同じでURLに対して任意のGETとかPOSTとかのリクエストを投げ、それに対して応答が返ってくる仕組みをAPIとして活用したもの。

さてAPIをたたいてみたいのだが、ちょっと試してみるためにOSSで何かREST APIを持ってるウェブアプリケーションか何かを探して構築するのはちょっと手間なので、世の中に無料かつ手間がかからず公開されているものを探してみようと思う。

http://zip.cgis.biz/

郵便番号から住所を返してくれるAPIを公開してくださっている方がいたのでこれを使ってみたい。
実験には十分だろう。

早速仕様を確認する。
リクエストメソッドはGET
URL、これはたぶんエンドポイントと言ってよいだろう。
　[XMLで受け取りたい場合] http://zip.cgis.biz/xml/zip.php
　[CSVで受け取りたい場合] http://zip.cgis.biz/csv/zip.php
とあるので、postmanで次のように設定し、送信してみると、

見事に次のようなxmlが得られた。

<?xml version="1.0" encoding="utf-8" ?>
<ZIP_result>
    <result name="ZipSearchXML" />
    <result version="1.01" />
    <result request_url="http%3A%2F%2Fzip.cgis.biz%2Fxml%2Fzip.php%3Fzn%3D1000001" />
    <result request_zip_num="1000001" />
    <result request_zip_version="none" />
    <result result_code="1" />
    <result result_zip_num="1000001" />
    <result result_zip_version="0" />
    <result result_values_count="1" />
    <ADDRESS_value>
        <value state_kana="ﾄｳｷｮｳﾄ" />
        <value city_kana="ﾁﾖﾀﾞｸ" />
        <value address_kana="ﾁﾖﾀﾞ" />
        <value company_kana="none" />
        <value state="東京都" />
        <value city="千代田区" />
        <value address="千代田" />
        <value company="none" />
    </ADDRESS_value>
</ZIP_result>

最も簡単なパターンの一つだと思うが、REST APIに初めて触れるに際しては簡単でよい題材といえるかも？