Skip to content
Postman API Testing Tips

How To Use Postman For Rest Api

API Testing Blog

Getting Started with Postman for REST API Testing

Postman is a powerful tool that simplifies the process of testing REST APIs. It offers a user-friendly interface for sending requests, inspecting responses, and managing API documentation. This guide will walk you through the basics of using Postman for REST API testing, including practical examples and code snippets.

1. Setting Up Postman

  • Download and Install: Visit the official Postman website and download the free version for your operating system.
  • Creating a Workspace: Postman uses workspaces to organize your collections, environments, and other data. Create a new workspace by clicking the “Create Workspace” button in the top right corner.
  • Importing API Documentation: You can import API documentation from various sources, including Swagger, OpenAPI, or Postman collections. This will automatically generate requests and tests within Postman.

2. Sending a Simple GET Request

Let’s start with a basic example of sending a GET request to fetch data from a fictional API that lists users.

Step 1: Creating a Request:

  • Go to the Postman interface and click on the “New” button to create a new request.
  • Select the “GET” method.
  • In the “Enter request URL” field, type the API endpoint: https://example.com/users

Step 2: Sending the Request and Examining the Response:

  • Click the “Send” button to execute the GET request.
  • Postman will display the response in the “Response” tab, including the status code, headers, and body.
  • Example response (JSON format):
[
  {
    "id": 1,
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  {
    "id": 2,
    "name": "Jane Smith",
    "email": "jane.smith@example.com"
  }
]

3. Utilizing Different HTTP Methods

Postman supports all common HTTP methods, including:

  • POST: Create new resources.
  • PUT: Update existing resources.
  • DELETE: Delete resources.
  • PATCH: Partially update resources.

Example: Creating a New User (POST Request)

  • Request URL: https://example.com/users
  • Method: POST
  • Body: JSON Payload
{
  "name": "Alice Johnson",
  "email": "alice.johnson@example.com"
}
  • Send the request and verify the response status code (201 Created) indicating success.

4. Managing Environments

Environments are crucial for managing different configurations for your tests, such as various API endpoints for development, staging, and production.

Step 1: Creating an Environment:

  • Go to “Manage Environments” (found under the “More” button).
  • Click “Add” to create a new environment.
  • Define variables like apiBaseURL and apiKey with values for each environment.

Step 2: Using Environments in Requests:

  • Replace hardcoded values in your request URLs with variables from your environment. For example, use {{apiBaseURL}}/users instead of https://example.com/users.
  • Postman will dynamically replace these variables with the appropriate values based on the selected environment.

5. Building and Running Collections

Collections are a powerful feature in Postman for grouping multiple requests and organizing API workflows.

Step 1: Creating a Collection:

  • Go to the “Create” tab and click “Collection”.
  • Provide a name for your collection, e.g., “User API”.
  • Add requests to the collection by dragging and dropping them or clicking the “Add Request” button.

Step 2: Running Collections:

  • Once you have a collection with requests, you can run them as a group.
  • Click “Run” and select the collection.
  • Postman will execute the requests in the order defined within the collection.

6. Asserting Responses (API Tests)

Postman allows you to write tests for your API requests, ensuring expected behaviors and responses.

Step 1: Adding Tests:

  • After sending a request, go to the “Test” tab.
  • Write JavaScript code using Postman’s built-in pm object to perform assertions.

Example: Testing a 200 OK status code:

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

Example: Testing the existence of a specific field in the response body:

pm.test("Response has the 'name' field", function () {
  pm.expect(pm.response.json().name).to.be.a("string");
});

7. Writing and Executing Scripts

Postman scripts provide more complex logic and automation capabilities.

Step 1: Adding Scripts:

  • Scripts can be added to requests using the “Pre-request Script” and “Test Script” tabs.

Example: Setting Headers in Pre-request Script:

pm.request.headers.add({
  "Authorization": "Bearer " + pm.environment.get("apiKey")
});

Example: Logging Response Data in Test Script:

console.log(pm.response.text());

8. Leveraging Postman for API Documentation

Postman offers tools for documenting your APIs, making them easier to understand and utilize.

Step 1: Creating Documentation:

  • Right-click on a collection and select “Add Documentation”.
  • Use Markdown to create detailed descriptions of each request and response.
  • Include examples and notes to clarify API behavior.

Step 2: Sharing Documentation:

  • You can share your documentation with other team members or make it publicly available using Postman’s built-in sharing features.

By utilizing these features, you can effectively document your APIs within Postman, enhancing collaboration and understanding.

API Testing Blog