APIをテストする時はPostmanが便利


Postmanとは

今までAPIを作成した時にそのAPIが正しく機能するかどうか確かめるために実際にプログラムを実行したり、製品(自分の場合はa-blog cms)を直接手動で確かめてテストしていました。
しかし、それではあまりにもめんどくさいので何かいいツールはないかと探したところPostmanというものを見つけました。

Postmanを使うと下の画像のようにAPIのURLを設定して、そこに入るパラメーターを設定するだけで簡単にGETやPOSTのテストができます。


Postman設定方法

GET

GETの場合は、APIのエンドポイントを設定して、下の画像のようにURLパラメーターを指定します。


また下の図のようにHeader情報も同時に設定できるのでCookieの情報までも持たせた状態でテストができます。つまりそのサービスにログインした状態でのレスポンスを確かめることができるのです。


下はとあるAPIの実行結果です。


POST

POSTの際もエンドポイントを指定し、Header情報を設定できます。Formから送信することが多いと思うのでPOSTの場合は、下の画像のようにBodyタブを設定することが多いです。JSON形式で指定することが多いです。


このようにBinaryのPOSTも出来ちゃうのは驚きです。


実行結果は下の「Send」ボタンを押すことで下に表示されます。


変数も設定できる

またPostmanでは以下のように変数も管理することができます。例えばローカルでテストしていると、webpack-dev-serverなどの都合上、ポート番号が変わることもあります。そう言った場合でも変数をrootURLなど、変数化しておくことによって、何箇所もAPIのテストを書き直すことなくテストができます。


つくったAPIコレクションの共有

またPostmanでは作ったAPIのコレクションを他の人と共有するためにJSONとしてコレクションをExportできたり、共有リンクを作成することなんかもできちゃいます!
めちゃくちゃ便利ですね!



Home
Next entry →