Environment file with Newman in Postman

Introduction

Environment files help you run the same tests with different settings easily. Newman uses these files to know which values to use during testing.

You want to test the same API on different servers like development, staging, and production.

You need to change API keys or tokens without editing your test scripts.

You want to share test settings with your team so everyone tests the same way.

You want to run automated tests with different user data or URLs.

You want to avoid hardcoding values inside your Postman collections.

Syntax

Postman

newman run collection.json -e environment.json

The -e option tells Newman which environment file to use.

Environment files are JSON files exported from Postman containing key-value pairs.

Examples

Run tests using the development environment settings.

Postman

newman run mycollection.json -e dev_environment.json

Run tests using the production environment settings.

Postman

newman run mycollection.json -e prod_environment.json

Run tests without any environment file, using default values.

Postman

newman run mycollection.json

Sample Program

This command runs the Postman collection named sample_collection.json using the environment variables defined in sample_environment.json. Newman will replace variables in the collection with values from the environment file during the test run.

Postman

newman run sample_collection.json -e sample_environment.json

Important Notes

Always export your environment file from Postman to keep the correct format.

Use descriptive variable names in your environment file for clarity.

You can have multiple environment files for different testing scenarios.

Summary

Environment files store variables to customize test runs.

Newman uses the -e option to load environment files.

This helps run the same tests with different settings easily.