Skip to content
Postman API Testing Tips

How To Do Rest Api Testing Using Postman

API Testing Blog

REST API Testing with Postman: A Comprehensive Guide

Introduction

Postman is a powerful tool for testing REST APIs. It allows you to send requests, inspect responses, and automate your testing workflow, making it a valuable tool for software testers and developers. This guide will walk you through the essential features of Postman for REST API testing and provide practical examples to get you started.

Understanding REST API Fundamentals

Before diving into Postman, it’s crucial to understand the basics of REST APIs:

  • REST (REpresentational State Transfer): An architectural style for building web services.
  • HTTP Methods: Common methods like GET, POST, PUT, DELETE, PATCH.
  • Resources: Data entities accessible through endpoints (e.g., /users, /products).
  • Endpoints: Specific URLs that identify resources (e.g., /users/123).
  • Headers: Additional information sent with requests, such as authentication tokens.
  • Responses: Server’s reactions to requests, including status codes (e.g., 200 - OK, 404 - Not Found), and data.

Setting up Postman

  1. Download and Install: Get the Postman app from https://www.postman.com/.
  2. Create a Workspace: Organize your requests and collections in workspaces. This is helpful for collaboration and managing different projects.
  3. Create a Request: Choose the appropriate HTTP method (e.g., GET, POST) and enter the endpoint URL (e.g., https://api.example.com/users).

How to Send and Inspect Requests

  1. Basic GET Request:

    • Method: GET
    • URL: https://reqres.in/api/users
    • Click “Send”
    • View Response: The response is displayed in the “Body” tab. In this case, it will likely be a JSON object containing user data.

  2. POST Request with Body Data:

    • Method: POST
    • URL: https://reqres.in/api/users
    • Body: Choose “raw” and select “JSON” as the format. Enter the following JSON:
    {
    "name": "John Doe",
    "job": "Software Engineer"
    }

    • Click “Send”

    • Response: The response will contain a status code (201 Created) and potentially a JSON object with the newly created user’s details.

Adding and Managing Collections

  • Organizing requests into collections is essential for better test management. Create a new collection and name it (e.g., “User API Tests”).
  • Add requests: Drag existing requests or create new ones within the collection.
  • Add descriptions: Write detailed descriptions for each request for clarity.
  • Run tests: Choose “Run Collection” to execute all requests in the collection, providing a consolidated view of test results.

Using Environment Variables

  • Environment: Define global variables that can be used across requests in a collection. This is helpful for switching between environments like development, testing, and production.
  • Create an Environment: Go to “Environments,” create a new one, and define variables like base URLs and API keys. Use the {{variable_name}} syntax to reference variables within requests.
  • Example: To use a base URL in your requests, create an environment variable BASE_URL and set its value to https://api.example.com. Your requests can then use ${BASE_URL}/users for the API endpoint.

How to Automate API Testing in Postman

  • Test Scripts: Write test scripts to validate API responses using JavaScript. This allows you to create assertions and checks for different scenarios.
  • Adding Tests to Requests: In the “Tests” tab of a request, add test scripts using pm.test() and pm.expect(): 
    pm.test("Status code is 200", function() {
      pm.expect(pm.response.status).to.be.equal(200);
    });
    

    pm.test("Response body has user data", function() {
    pm.expect(pm.response.json().data.name).to.be.equal("John Doe");
    });
  • Running Collections with Tests: Choose “Run Collection,” and Postman will execute the tests in each request within the collection, providing a comprehensive test report.

Additional Features

  • Authentication: Postman supports various authentication mechanisms like Basic, OAuth 2.0, API keys, and more.
  • Mock Servers: Simulate API responses for testing without relying on a live server.
  • Data-Driven Testing: Use data files (like CSV or JSON) to parameterize test requests, creating robust scenarios.
  • Postman API: Integrate Postman’s API into your automation frameworks for scripting-based testing.

Conclusion

Postman provides an intuitive and powerful platform for effective REST API testing. By mastering the fundamentals of REST APIs and utilizing Postman’s features for sending requests, managing collections, and automating tests, you can significantly improve the quality of your software applications. The provided practical examples and step-by-step guidance will equip you with the necessary skills to confidently test and validate your REST APIs with Postman.

API Testing Blog