Skip to content
Postman API Testing Tips

How To Use Postman For Express Js

API Testing Blog

A Comprehensive Guide to Using Postman for Express.js API Testing

Postman is a powerful tool for testing APIs, and when working with Express.js, it becomes invaluable for streamlining your development workflow. This guide will walk you through the essentials of using Postman for testing your Express.js APIs, providing practical examples and step-by-step instructions.

Setting up your Express.js Application

Before diving into Postman, you’ll need a basic Express.js application to test. Let’s create a simple example:

const express = require('express');
const app = express();


// Define routes
app.get('/users', (req, res) => {
  const users = [
    { id: 1, name: 'John Doe' },
    { id: 2, name: 'Jane Doe' }
  ];
  res.json(users);
});


app.post('/users', (req, res) => {
  const newUser = req.body;
  res.status(201).json(newUser);
});


// Start the server
app.listen(3000, () => {
  console.log('Server listening on port 3000');
});

This code sets up a simple Express.js application with two routes: /users for fetching users (GET) and /users for creating new users (POST).

Using Postman for API Testing: A Step-by-Step Guide

  1. Installing Postman:

  2. Creating a New Request:

    • Open Postman and click on the “New” button to create a new request.

  3. Choosing the HTTP Method:

    • Select the desired HTTP method from the dropdown (GET, POST, PUT, DELETE, etc.). For example, to test the GET /users route, select “GET.”

  4. Setting the Request URL:

    • In the “Enter request URL” field, enter the URL of your API endpoint. Here, it would be http://localhost:3000/users.

  5. Sending the Request:

    • Click the “Send” button to execute the request.

  6. Viewing the Response:

    • Postman displays the response from your server in the “Body” tab. You can see the response status code (e.g., 200 for success), headers, and the response data in JSON format.

Testing GET Requests

Let’s test the GET /users route:

  1. Create a GET request: Follow steps 1-4 above, choosing “GET” and http://localhost:3000/users as the URL.
  2. Send the request: Click “Send.”
  3. Verify the response: You should see an array of user objects in the response body, confirming that the GET request successfully retrieved data.

Testing POST Requests

To test the POST /users route:

  1. Create a POST request: Choose “POST” as the method and http://localhost:3000/users as the URL.

  2. Set the request body: Click on the “Body” tab and select “raw.” Choose “JSON” as the format and enter the following JSON data:

    {
      "name": "Alice Smith"
    }

  3. Send the request: Click “Send.”

  4. Verify the response: The response should include a 201 status code, indicating a successful creation, and the newly created user object in the response body.

Utilizing Postman Collections for Organized Testing

Postman Collections allow you to group related requests, making your testing more structured and efficient.

  1. Create a new Collection: Click on the “Collections” tab and create a new Collection. Name it something like “Express.js API.”

  2. Add Requests to the Collection:

    • Drag and drop or copy and paste existing requests into the collection.
    • Alternatively, create new requests directly within the collection.

  3. Organize Requests with Folders (Optional):

    • Create folders within the collection to organize requests by resource type or functionality (e.g., “Users,” “Products,” “Orders”).

Using Environment Variables for Flexibility

Environment variables allow you to manage testing parameters like base URLs or API keys in a centralized way.

  1. Create a New Environment:

    • Click on the “Environments” tab and create a new environment. Name it something like “Development” or “Production.”

  2. Add Environment Variables:

    • Click on the “Add” button and define variables like:

      Name: BaseURL
      Value: http://localhost:3000

  3. Use Environment Variables in Request URLs:

    • In your request URLs, use the variable name enclosed in double curly braces (e.g., {{BaseURL}}/users). This will ensure that the correct endpoint is used based on the selected environment.

  4. Switch Between Environments:

    • Select the desired environment before sending a request. Postman will automatically substitute the corresponding values for your variables.

Leveraging Postman’s Built-in Features

Postman offers a wide range of features to enhance your API testing:

  • Pre-request Scripts:
    • Run JavaScript code before each request. Useful for setting up data or authentication.
  • Test Scripts:
    • Write JavaScript code to verify the response of your requests.
  • Assertions:
    • Use built-in assertions to check specific conditions in your API responses (e.g., status code, body content, headers).
  • Mock Servers:
    • Create mock servers to simulate API behavior without depending on a real server.

Testing Authentication with Postman

Postman makes it possible to test authenticated APIs. Common authentication types include:

  • Basic Authentication:

    • In the authorization tab, select “Basic auth.” Enter your username and password.

  • API Key:

    • Select “API Key.” Provide the key name and its value.

  • OAuth 2.0:

    • Select “OAuth 2.0.” Configure the required OAuth settings.

Using Postman for Continuous Integration (CI)

Postman can be integrated into your CI/CD pipeline for automated testing:

  1. Export the Collection:

    • Export your Postman collection as a JSON file.

  2. Use the Newman Command Line Tool:

    • Install Newman: npm install newman -g

  3. Run the Tests:

    • Run the exported collection with Newman: newman run my-collection.json

Conclusion

Postman empowers developers and testers alike to efficiently test Express.js APIs. By utilizing its comprehensive features, you can streamline your API testing workflow, improve the quality of your applications, and ensure a robust and reliable API experience.

API Testing Blog