君はポストマンを感じたことがあるか?
みなさんお馴染みのポストマン様ですが、ご存知ない方のためにざっくりご紹介。
簡単にいうとポストマンはコードを実装せずにAPIリクエストを行うことができ、そのレスポンスを受け取れるという素晴らしいサービス。
何が嬉しいのかというと、例えば「ドキュメントを読んだけどどんな形でレスポンスが返ってくるのか実際の値を見たい」「取得したい値があるんだけど、ほんとにこの値で合ってるのかな?」等々、実際に動かしてみないとイメージがつかない部分を実装前に手軽に確認できるという点。
APIを利用した実装を行なっているとこういうことよくありますよね。
自分は以下のようなシーンでよく使っています。
・クライアントから「このAPIを利用してこういうことがしたい(ふんわり)」という相談を受けたときに、
そのAPIでできること、できないこと、何が必要となるかなどを事前にポストマンで確認する
・実装を始める前にポストマンでレスポンスを確認して、その内容を基に後工程の実装を考える
具体的な使い方(AmazonAdsを例に)
・amazonAdsさんはとても親切なのでpostman collectionという、ポストマンのリクエストテンプレートのようなものをご用意してくれています。
・「environment file」と「collection file 」から得られるURLをコピー
・ポストマンのimportボタンを押下し、表示された画面に上記URLを貼り付け
・するとこのようにamazonAdsのAPIリクエストテンプレートがずらっと表示されます
・各ファイルの内容は各APIのリクエストに沿ったheaderやparamsが設定されたリクエストのテンプレートとなっており、赤色部分に必要な値を入れれば簡単にリクエストができてしまうというわけです。
※今回はamazonAdsのAPIを利用したpostmanの内容ですので基本的な部分は割愛させていただきます