1. はじめに:なぜ環境変数?
APIエンドポイント、認証情報、テストデータなどを変数として管理してあげることで、複数のリクエストで再利用できます!
これにより、同じ情報を何度も入力する手間を省き、テストと開発の効率UP!
2. 環境変数の作成
-
環境作成:
-
変数設定:
-
環境切り替え:
- Postman右上ドロップダウンで選択
3. 環境変数の活用
-
URL管理:
-
{{api_url}}
で参照 - 例:開発環境
api_url = "http://dev.xxxx.com"
-
-
認証情報:
- APIキー、トークンを安全に管理
- 例:
{{api_key}}
-
テストデータ:
- ID、名前などを環境ごとに設定
- 例:
{{user_id}}
-
スクリプトでの利用:
-
pm.environment.get("変数名")
で取得 - 例:
let url = pm.environment.get("api_url");
-
4. 注意点
-
命名規則:
-
API_URL
、AUTH_TOKEN
など、大文字スネークケース
-
-
機密情報:
- 現在値のみ設定、共有しない
-
チーム共有:
- Postman Cloud、JSONエクスポート/インポート
5. newmanコマンドで環境ファイルを指定して実行
こちらの記事でnewmanの実行方法を記載したが、オプションを設定することで環境ファイルを適用することができる
1.Environmentsを右クリックしてExport
2.
newman run コレクション名.json -e 環境ファイル名.json
6. まとめ
環境変数を利用することでAPIテストを効率化することができます!
自動テスト始めたてだったりすると、変数という概念を知らず直接入力で動作を試し始めると思いますが、環境変数を理解することでかなりテストの幅が広がるし効率的で楽しくなります。