Skip to content
Postman API Testing Tips

How To Use Environment In Postman

API Testing Blog

Harnessing the Power of Environments in Postman: A Comprehensive Guide

Postman is a powerful tool for API testing, and one of its key features is the ability to manage environments. Environments allow you to store and easily switch between different sets of API endpoints, authentication credentials, and other configuration values. This is crucial for testing your APIs in various scenarios, such as development, staging, and production.

Understanding Environments in Postman

An environment in Postman is essentially a collection of key-value pairs. Each key represents a variable, and its corresponding value can be anything, like a URL, username, password, API token, etc. When you’re working with a specific environment, Postman automatically substitutes the values from that environment into your requests.

Let’s break down how you can effectively utilize environments within your Postman workflow.

Creating and Managing Environments

  1. Creating a New Environment:

    • Go to Postman and click the Environments tab located within the Collections section.

    • Click the “Add” button to create a new environment.

    • Give your environment a descriptive name, such as Development, Staging, or Production.

    • Add the necessary variables by clicking “Add a Variable”.

    • Each variable requires a name and a value:

      {
        "id": "development",
        "name": "Development",
        "values": [
          {
            "key": "baseUrl",
            "value": "https://api.example.com/v1",
            "enabled": true
          },
          {
            "key": "apiKey",
            "value": "your-development-api-key",
            "enabled": true
          }
        ]
      }

  2. Managing Existing Environments:

    • Once you’ve created your environments, you can easily edit them by clicking on their names within the Environments tab.
    • You can add, remove, or modify variables as needed.
    • You can also enable or disable specific variables within an environment.

Using Environments in Your Requests

  1. Selecting an Environment:

    • From the dropdown list in the top right corner of the Postman UI (next to the “Runner” button), select the environment you want to use.

  2. Referencing Environment Variables in Your Requests:

    • Use double curly braces to reference environment variables within your request URL, headers, or body.

      // Request URL
      {{baseUrl}}/users

    • Replace baseUrl with the actual name of the variable you’ve defined in your environment.

    • Postman will automatically replace the variable with its corresponding value.

Example: API Testing with Environment Variables

Let’s consider an example of testing a weather API.

  1. Define Environments:

    • Create three environments: Development, Staging, and Production.
    • Define the following variables in each environment:
      • baseUrl: The base URL of the weather API for each environment.
      • apiKey: The API Key for each environment.
    // Development environment
    {
      "id": "development",
      "name": "Development",
      "values": [
        {
          "key": "baseUrl",
          "value": "https://api.example.com/v1/dev",
          "enabled": true
        },
        {
          "key": "apiKey",
          "value": "your-development-api-key",
          "enabled": true
        }
      ]
    }
    

    // Staging environment
    {
      "id": "staging",
      "name": "Staging",
      "values": [
        {
          "key": "baseUrl",
          "value": "https://api.example.com/v1/staging",
          "enabled": true
        },
        {
          "key": "apiKey",
          "value": "your-staging-api-key",
          "enabled": true
        }
      ]
    }

  2. Construct Your API Request:

    • Create a GET request to retrieve weather data for a city:
    // API Request
    GET  {{baseUrl}}/weather?q=London&appid={{apiKey}}

  3. Test with Different Environments:

    • Run the request with Development environment selected.
    • Switch to Staging or Production and re-run the request. Postman will automatically update the request with the correct base URL and API key for each environment.

Best Practices for Using Environments

  • Use Descriptive Variable Names: Make sure your variable names are clear and self-explanatory to improve readability.
  • Separate Environments by Test Stage: Keep different environments distinct, such as for development, testing, and production.
  • Keep Sensitive Information Secure: Use environment variables to store confidential information like API keys, passwords, and database connections.
  • Use Environments for Different Data: Switch environments to test APIs with different datasets (e.g., test data vs. production data).

Conclusion

Environments are an essential aspect of effective API testing with Postman. They allow you to streamline your testing process, make your test cases more robust, and ensure that you’re testing your APIs under a variety of configurations. By leveraging the power of environments, you can confidently test your APIs and ensure they perform as expected across different stages of development.

API Testing Blog