Skip to content
Postman API Testing Tips

How To Use Postman Medium

API Testing Blog

Mastering Postman for API Testing: A Comprehensive Guide

Postman is a powerful tool used by developers and testers worldwide for API testing and development. It allows for easy sending and receiving requests, managing APIs, creating automated tests, and generating documentation. Let’s dive into a comprehensive guide on using Postman for your API testing needs.

1. Setting Up Postman

To get started, download and install Postman from their official website. Postman is available for various operating systems, including Windows, macOS, and Linux.

2. Creating a New Request:

2.1. Basic GET Request

Postman offers a user-friendly interface for building requests. Let’s begin with a simple GET request to the “https://reqres.in/api/users” endpoint:

  1. Open Postman: Launch Postman and click on the “New” button.
  2. Select method: Choose “GET” from the dropdown menu (located at the top).
  3. Enter URL: In the “Enter request URL” field, type “https://reqres.in/api/users”.
  4. Send request: Click on the “Send” button. Postman will execute the request and display the server’s response in the “Body” tab.

Here’s a breakdown of the code:

GET https://reqres.in/api/users

2.2. Modifying Request Headers & Parameters

Now, let’s add a custom header and query parameters to our GET request.

  1. Add Headers: Click on the “Headers” tab.
  2. Create a Header: Enter “Content-Type” in the “Key” field and “application/json” in the “Value” field. Click on the “Add” button to add the header.
  3. Add Query Parameters: Click on the “Params” tab.
  4. Create a Parameter: Enter “page” in the “Key” field and “2” in the “Value” field. Click “Add” to add the parameter. Finally, send your GET request. You should see the results of the second page of users.

Here’s the code with the added headers and parameters:

GET https://reqres.in/api/users?page=2


Headers:
Content-Type: application/json

3. Working with the Response:

3.1. Analyzing the Response Body

The “Body” tab displays the response body in various formats like JSON, XML, and HTML. Postman also allows you to prettify the response for better readability.

  1. Response Body: Observe the response body and data you have received. In this case, you will see JSON data containing user information.
  2. Prettify response: Click on the “Pretty” button to format the response.
  3. Inspect response headers: The “Headers” tab will show the server’s response headers, including status code, content type, and other important information.

4. Testing Your APIs:

4.1. Creating Automated Tests

Postman provides advanced testing features for verifying your API responses.

  1. Tests Tab: Switch to the “Tests” tab.
  2. Add a Test: Use the provided testing snippets or write your own JavaScript code to check the response status, content type, and data correctness.
  3. Example Test: Let’s add a test to check if the response status code is 200 (OK) for a GET request. 
    pm.test("Status code is 200", function () {
        pm.response.to.have.status(200);
    });

4.2. Running Tests

  1. Save the Request: Click on “Save” to save your request with the test.
  2. Run Test: Click on the “Send” button to execute the request and execute the test. The results will be displayed in the “Test Results” section.

5. Building Collections:

5.1. Organizing Requests in Collections

Collections are a great way of organizing your API requests. You can create a collection and add requests to it. This allows you to easily manage and access related API calls.

  1. Create Collection: Click on the “New” button and select “Collection”.
  2. Name the collection: Provide a name for your collection (e.g., “User API”).
  3. Add requests: Add existing requests to the collection by dragging them from the “Requests” section or create new requests directly in the collection.

6. Running Collections:

6.1. Running Multiple Requests

Collections allow you to execute multiple requests in a sequential manner.

  1. Select Collection: Open the collection that you want to run.
  2. Run Collection: Click on the “Run” button. Postman will execute each request in the collection one by one, displaying the results for each request.

7. Generating Documentation:

Postman allows you to generate API documentation based on your collections.

  1. Open Collection: Select the collection you want to document.
  2. Generate Documentation: Click on the “Documentation” button and choose the desired format (e.g., Markdown, HTML).

Wrapping Up

This comprehensive guide has covered the fundamental aspects of using Postman for API testing. Explore other features of Postman like:

  • Environment Variables: Store and manage sensitive data like API keys securely.
  • Data-Driven Testing: Parameterize requests with data sets to test multiple inputs.
  • Mock Servers: Simulate backend responses to test API integrations without a live server.

Postman is a robust platform that empowers developers and testers to streamline their workflow and deliver quality APIs. Remember to explore all its functionalities for more advanced API testing strategies.

API Testing Blog