Skip to content
Postman API Testing Tips

How To Test A Rest Api Using Postman

API Testing Blog

A Comprehensive Guide to REST API Testing with Postman

Postman is a powerful tool that streamlines your workflow for testing REST APIs. This comprehensive guide will walk you through the essentials of API testing with Postman, covering everything from basic requests to advanced features.

1. Setting up Postman

  • Download and Install: Begin by downloading and installing Postman from https://www.postman.com/. Postman is available as a desktop app and a web application.
  • Create a Workspace: Workspaces help you organize your API projects. Create a workspace for your specific API by clicking on “Workspaces” in the left sidebar.
  • Add a New Request: Create a new request by clicking ”+ Create” in the top left corner and selecting “Request”.

2. Sending Your First REST API Request

  • Enter the API Endpoint: Replace "https://example.com/api/users" with the actual endpoint URL of your API.
  • Choose HTTP Method: Select the HTTP method (e.g., GET, POST, PUT, DELETE) required for your API interaction.
  • Add Headers:
    • Content-Type: Specify the format of the data you’re sending (e.g., “application/json”).
    • Authorization: Include authorization headers if your API requires authentication.
  • Add Body (Optional): For POST, PUT, and PATCH requests, you often need to send data in the request body. Select the appropriate body format (e.g., JSON, form-data, raw).
    • Example JSON Body:
    {
      "name": "John Doe",
      "email": "john.doe@example.com"
    }

Sample Code (GET Request):

// Endpoint: https://example.com/api/users
GET https://example.com/api/users

Sample Code (POST Request):

// Endpoint: https://example.com/api/users
POST https://example.com/api/users


// Body (JSON)
{
  "name": "John Doe",
  "email": "john.doe@example.com"
}

3. Sending and Inspecting API Responses

  • Send Request: Click the “Send” button to execute the request.
  • Examine the Response: Postman displays the response in various tabs:
    • Body: View the response data (JSON, XML, text).
    • Headers: Inspect response headers (e.g., status code, content type).
    • Cookies: See any cookies set by the API.
  • Asserting Expected Outcomes: Verify that the API response meets your expectations.

Example Responses:

  • Successful GET Request:
    • Status Code: 200 OK
    • Body: 
      [
        {
          "id": 1,
          "name": "John Doe",
          "email": "john.doe@example.com"
        },
        {
          "id": 2,
          "name": "Jane Doe",
          "email": "jane.doe@example.com"
        }
      ]
  • Successful POST Request:
    • Status Code: 201 Created
    • Body: 
      {
        "id": 3,
        "name": "John Doe",
        "email": "john.doe@example.com"
      }
  • Error Response:
    • Status Code: 400 Bad Request
    • Body: 
      {
        "error": "Invalid email format"
      }

4. Using Postman Collections for API Testing

  • Create a Collection: A collection is a group of related API requests that can be organized and executed together. Click on “Collections” in the left sidebar and create a new collection for your API.
  • Add Requests to Your Collection: Add the requests you’ve created to your collection.
  • Run Collections: You can execute all the requests in your collection sequentially. This is helpful for testing complex API workflows.
  • Environment Variables: Create environment variables to store sensitive data like API keys, URLs, or test data. This enables you to easily change values across multiple requests without modifying each one manually.
  • Pre-request Scripts: Automate actions before sending a request, like setting variables or generating test data.
  • Tests: Add test scripts to verify expected responses, including validation of response bodies, headers, and status codes.

5. Automating Tests with Postman Runner

  • Postman Runner: Postman Runner allows you to run collections and individual requests repeatedly. It can be used for automated testing.
  • Iteration and Data Files: Use iteration to execute your tests against different datasets. Upload data files in CSV or JSON format to send different values for each request in a collection.
  • Test Reporting: Postman Runner generates detailed reports on test execution. This provides valuable data for tracking the health of your API and identifying any regressions.

Example Test Script:

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


pm.test("Response has a valid JSON body", function () {
  pm.response.to.have.jsonBody();
});


pm.test("Response includes the expected name", function () {
  var jsonData = pm.response.json();
  pm.expect(jsonData.name).to.equal("John Doe");
});

6. Advanced API Testing Techniques

  • Mock Servers: Use Postman’s mock server feature to simulate API responses without relying on a live backend. This is helpful for testing in development environments or when you need to simulate specific responses.
  • Webhooks: Configure webhooks to trigger automated tests whenever changes are made to your API. This enables continuous testing and ensures that your API remains stable after updates.
  • Data-driven Testing: Generate parameterized tests by loading data from external sources like CSV files. This allows you to test multiple scenarios with varying input parameters.
  • Integration with CI/CD: Integrate Postman with your continuous integration and continuous delivery (CI/CD) pipeline. This ensures that API testing is automated and executed as part of your deployment process.

Conclusion

By leveraging the features of Postman, you can significantly enhance your API testing process. Postman simplifies sending requests, inspecting responses, writing automated tests, and organizing your work, making it an indispensable tool for anyone involved in API development or testing. Remember to continually explore new features and workflows within Postman to tailor your API testing to your specific needs.

API Testing Blog