これまでもWebAPIのテスト実行にはPostmanを使ってきたが、最近まで知らなかったことがあったのでメモを残す。
Environmentって?
Environmentで何ができるか?について、簡単に説明すると、API実行時の環境変数の様なものを定義することができる機能、である。
APIではよく認証した証跡としてトークンを払い出し、各APIのヘッダ等にトークンを指定するということがあると思う。
毎回毎回、払い出されたトークンをヘッダのvalueにコピペをしていたが、これが結構おっくうに感じていた。
こんな「ちょっとめんどくさい」と思う手順をEnvironmentは解消してくれる。
Environmentの設定
設定はとても簡単。
Postmanウィンドウの左上のNewボタン>Environmentを選択。
Environmentの名称を入力。(これは、Environmentの選択プルダウンに表示される)
任意のkeyとvalueを設定する。入力が完了したらAddボタンを押下する。
以上で完了。
Environmentの使用
使用方法も簡単。
任意の箇所(URL欄、パラメータ欄、pre-script欄等、どこでもけっこうどこでも呼び出せる)でkeyを{{}}で囲うことで使用できる。
http://localhost:8080/hogehoge/{{key}}
{を入力した時点でインテリセンスのような予測機能で候補が表示されるため、入力も簡単にできる。
また、tests(リクエスト完了後に実行されるscript)内でレスポンスの値をEnvironmentで定義したkeyにセットすることもできるので、Runnerで実行する際の自由度もかなり上がる。
Postmanを使用していてEnvironmentを使用していない場合はお試しあれ。