バックエンドでAPIの開発やデバッグ行うときにはGUIツールの「Postman」がオススメです。データ取得のGETメソッドはもちろんのこと、ブラウザからは難しいPOSTでAPIを叩くケースなどもアプリ上から簡単に実行することができます。無料で使えるので是非導入しておきたいですね。
Postmanのインストール
インストーラーのダウンロードですが、まずは公式サイト(https://www.getpostman.com/)にアクセスします。表示される画面に大きく「Get Started」のボタンがあるのでクリックしてダウンロードページに進みます。
Macであればそのままダウンロードボタンが表示されていますので、クリックするとインストーラーファイルのダウンロードが始まります。その他のOSの場合は下のリンクを選択します。
インストールが終了し、アプリを立ち上げるとこのような画面が表示されます。メインの操作エリアは大きく2つに分かれており、上部には「リクエスト」下部は「レスポンス」のデータを扱う部分になります。そして最上部にはGETやPOSTといったAPIのメソッドを選択する項目と、アクセスするAPIのURL入力のフォームが設置されています。
APIにアクセスしてGETメソッドでデータを取得する
開発によって様々な使い方がありますが、基本的な使い方として、GETのメソッドでAPIにアクセスし、データを取得する例を見ていきます。
まずはメソッドをGETに設定し、APIのURLを入力します。そして「Send」のボタンをクリックすると下記のようにレスポンスのBodyタブを選択するとレスポンスの結果エリアにデータが表示されます。表示オプションも様々な設定が可能です。
リクエストボディの値をPOSTメソッドでレスポンスとして取得する
ブラウザから直接POSTのAPIを叩くためには専用に実装などが必要になりますが、Postmanを使うことで手軽に試すことができます。先ほどと同じくPOSTのメソッドを指定し、APIのURLを入力します。
そして、リクエストのところでBodyタブを選択し、入力エリア内に値を直接入力します。ここではJSON形式で値を入れる前提のため「raw」の形式で右側にあるフォーマットを「JSON」で選択しています。そして、上部にある「Send」ボタンをクリックすると、下のレスポンスのエリアにレスポンスボディとして、リクエストボディでPOSTした値が返ってくるのが確認できます。
また、それ以外にもPostmanではいろんな機能が用意されています。認証系のAPIで必須となるAuthorizationの設定やレスポンスヘッダ、リクエストヘッダなどの値も確認することができます。
今回はAPI開発が捗るツールのPostmanについて導入と基本的な使い方についてまとめていきました。バックエンドの開発でAPIを実装する際には是非とも導入しておきたいツールですね。