PostmanでAPIの動作確認をする

サーバと通信を行うアプリを作っていると、サーバのAPIを呼んだ時に想定通りのデータが返ってくるか、チェックが必要になります。
しかし様々なデータを毎回アプリを通してチェックをしていたのでは、手間がかかってしまいます。
そこで今回は、そういったサーバから返ってきたデータのチェックに使えるツールである、Postmanを紹介します。

入手方法

公式サイトからダウンロードする方法とchromeのウェブストア版があります。

https://www.getpostman.com/

www.getpostman.com

Postman - Chrome Web Store

POSTMAN CHROME IS DEPRECATED DOWNLOAD THE UPDATED POSTMAN NATIVE APPS Postman Chrome is deprecated and is missing essential, new…

chromewebstore.google.com

起動画面

これは公式サイトからダウンロードしてきたmac版です。
バージョンは6.4.4です。

テストに使うAPI

今回は次のようなAPIをサーバに用意しました。
これはPOST送信したデータをJSONに変換して送り返してくるAPIです。

public  function  sample(){
    if($this->request->is('post')){
        $ret = 'return message';
        $ret = $this->request->data();
        $this->viewBuilder()->className('Json');
        $this->set(['result'=>$ret,'_serialize'=>['result']]);
    }
}

データの送信

今回はPOST送信を試します。
まず、GETと表示されているボタンを押して表示される一覧からPOSTを選択します。

次に、チェックするAPIのURLアドレスをPOSTボタンの右にある欄に入力します。
それからその下のタブでbodyを選択し、送信するデータを入力していきます。
keyが変数名、valueがその変数の値になります。
入力し終えたらURL入力欄の右側にあるSendボタンを押してデータを送信します。

受信データの確認

データを送信すると、ツールの下に結果が表示されます。

送ったデータがJSONにまとめられて返ってきています。

最後に

このように、Postmanはサーバから期待通りのデータが返ってくるかや、他にも間違ったデータを送信した場合にちゃんとエラーメッセージが返ってくるかなどのチェックが簡単にできるため、APIの動作確認にとても役立ちます。

k_saitou

エンジニア１年目です。
日々勉強したことをまとめていきたいと思います。