見出し画像

Postman_environmentsとcollection variableを設定する #425

こちらのPostman Meetupに参加させていただいて、いい感じの設定を学べたので簡単に整理しておきます。

Postmanとは、ご存知の通りAPI開発に欠かせないツールで、簡単にAPIを叩いてレスポンスを表示することができます。

environmentsを設定する

Postmanでは、environmentsを使って環境ごとのURLやトークンを管理できます。これは例えば以下の用途で使われます。

・APIのホストURLの指定
・アクセストークンの保持
・プルリクのデプロイバージョン番号の指定

Postman Meetupより

これは例えば環境ごと(LOCAL, DEC, STG, PROD等)や開発ツールごとに環境変数を使い分けたい時などに便利です。Postmanのデスクトップアプリケーションの左側にあります。

Globalsは全共通の変数でして、私のチームではここにアクセストークン関係の変数をまとめて保持しています。

左上の「+」から新しいenvironmentを作成できます。LOCALという名前で新規作成し、Globalsと同じ変数を設定してみました。

APIリクエストの送信画面の右上でenvironmentを選択できます。ここで新規作成したenvironmentを選択します。「No Environments」を選択すると、Globalsのみが適用されます。

↑{{}}で囲むことで変数を呼び出せます。

collection variableを設定する

続いてcollection variableです。これによりコレクションに依存する値を管理できます。セットする方法は簡単です。

collectionsのフォルダをクリックして、フォルダページのタブにある「Pre-request Script」で、「Set a collection variable」というSnippetをクリックします。

そうするとScriptが自動生成されるので、キーとバリュー部分に設定したい変数と値を入力するだけです。ここでは「path」という変数をセットしてみました。

environmentと同様、呼び出したい場所で{{}}で囲むことで使えます。


これらを上手く使い分ければ、環境ごと、開発対象ごとにパッと変数を変えられて便利そうです。

ここまでお読みいただきありがとうございました!!

いいなと思ったら応援しよう!