Skip to content
Postman API Testing Tips

How To Use Postman For Api

API Testing Blog

Understanding Postman for API Testing

Postman is a powerful tool used for interacting with APIs. It provides a user-friendly interface for sending requests, receiving responses, and testing APIs. In this guide, we’ll delve into how to leverage Postman for comprehensive API testing.

Setting Up Postman

  1. Install Postman: Download and install Postman from https://www.postman.com/. You can choose either the native desktop application or the web version.
  2. Create a Workspace: A workspace allows you to organize your API projects, collections, and environments.
  3. Import API Documentation: If your API has documentation, import it into Postman to automatically create requests and collections.

Sending Your First API Request

Let’s start with a simple HTTP GET request to fetch data from a public API.

  1. Create a Request:
    • Click on the “New” button and select “Request”.
  2. Specify URL:
    • Input the API endpoint URL in the request builder. For example: https://api.example.com/users.
  3. Select Method:
    • Choose the HTTP method for your request. In this case, we’ll use “GET”.
  4. Send the Request:
    • Click the “Send” button.
  5. Examine the Response:
    • The response from the API will be displayed in the response body, including the status code, headers, and data.

Practical Example: Testing a User API

Let’s consider an example where we want to test a user API with the endpoint /users/.

1. Create a Collection for API Tests

  • Click “New” > “Collection” to create a new collection for your API tests.
  • Name it “User API Tests”.

2. Add a Request for Creating a User

  • Within the collection, click “Add Request”.
  • Name the request “Create User”.
  • Set the following:
    • Method: POST
    • URL: https://api.example.com/users/
    • Headers:
      • “Content-Type”: “application/json”
    • Body:
      • Raw
      • Choose JSON
      • Paste the following sample request body: 
        {
            "name": "Jane Doe",
            "email": "jane.doe@example.com"
        }

3. Send the Request and Validate the Response

  • Click “Send”.
  • On the response tab, check for a successful 201 Created status code.
  • Verify the response body matches the expected user data. You can use the “Test” tab to write assertions using JavaScript to verify the response.

4. Add a Request to Get a User by ID

  • Create a new request named “Get User”.
  • Set the following:
    • Method: GET
    • URL: https://api.example.com/users/:userId (use a parameter :userId that you’ll replace with a specific user ID)

5. Use Environment Variables

  • Create a new environment named “dev” to hold the base URL and user ID for our tests.

  • Add variables:

    • baseUrl: https://api.example.com
    • userId: a valid user ID retrieved from the “Create User” response.

  • Update the request URLs to use these variables:

    • “Create User” URL: ${baseUrl}/users/
    • “Get User” URL: ${baseUrl}/users/${userId}

  • Select “dev” as the environment for your collection.

6. Run the Collection and View Results

  • Go to the “Run” tab in your collection.
  • Click “Run” to execute the requests in sequence.
  • Examine the test results in the “Run” tab. You’ll see the request details, response status codes, and any failures that occurred.

Advanced Postman Techniques

1. Writing Tests with Assertions

Postman provides powerful testing capabilities using JavaScript. You can use assertions to validate the expected behavior of your API.

pm.test("Status code is 201", function () {
    pm.response.to.have.status(201);
});


pm.test("Response body contains 'Jane Doe'", function () {
    pm.expect(pm.response.text()).to.include('Jane Doe');
});

2. Using Pre-request Scripts

Pre-request scripts enable you to execute code before sending a request. You can use them to generate dynamic data, set headers, or authenticate requests.

pm.environment.set("userId", pm.response.json().id);

3. Data-driven Testing with Collections

Collections can be used to test different scenarios with varying input data.

  • Create a data file in JSON or CSV format containing test data.
  • Use the “Data” tab to link the data file to your collection.
  • Postman will run each request in your collection multiple times, iterating over each row of the data file.

4. Authentication and Authorization

Postman allows you to handle various authentication mechanisms like API keys, OAuth, basic auth, and more.

  • Configure your API key or access token within the request headers or as environment variables.
  • Use Postman’s UI to easily set up and manage authentication.

Conclusion

Postman is a vital tool for API developers and testers. By following this step-by-step guide, you can harness its features to create robust tests, ensure API quality, and accelerate the development lifecycle. With its ease of use, comprehensive features, and advanced testing capabilities, Postman is an indispensable asset in your API testing toolkit.

API Testing Blog