はじめに
みなさんは API のレスポンス確認など、何を使用しているだろうか？
私は chrome や firefox などに直接リンクを入力してレスポンスを確認していた。しかし、API のレスポンス確認で便利そうなソフトを教えてもらったので、インストールして使ってみた。
Postman のインストール
# このコマンドでインストールできる
sudo snap install postman
Show Application 内にこのアイコンがあればインストールは成功している。
開いてみる
Postman を使用するのにアカウント登録が必要なのでアカウントを登録する。
実際に開くとこんな感じ
使ってみる
実際に Google のリンクを叩いてみる
左側の Collections タブ内に Collection を作成し、その中に Add request を押してテスト用のリクエストを作成する。
request を開いて実際に設定してみる
リンクを入力できる場所があるので、そこに Google のリンクを入力し、検索用のパラメーター q= を設定してみる。そして設定できたら Send を押してリクエストを送信する。
すると、下部にレスポンスが表示される。
この設定はリクエストごとに保存しておけるので、何度も API を叩く開発陣が使用するのにすごく便利である。
環境変数を作って使ってみる
この設定がメチャクチャ便利。API の実装ではステージング環境と本番環境などに分け、テストしてから本番に反映するといった工程を取ると思うが、ドメインを変えるのがめんどくさい！など思ったことがあるだろう。
しかし、この環境変数を使用することで、ワンクリックで検証環境を変更できる。
使い方は Collection 内の Variables もしくは
Environment タブ内の環境を選択する。
ここではそれぞれ、変数名 / 初期値 / 現在値 を設定することができる。
例として Collection 内の Variables に変数をセットしてみた。
これを先程の request で使用してみると、このような形で表記することができる。
このように変数化すると、使いまわすときや環境を変えるときにわざわざ同じ文字列を入力せずにすむ。
Collection 内の Variables に設定すると効果範囲はその Collection 内の request のみ。
Environment に書くとその Workspace 全体に効果がかかる。
また、Environment は右上の "No Environment" と書かれたところから設定できるので、全体の環境を切り替える場合はこちらのほうが便利かもしれない。
参考