Skip to content
Postman API Testing Tips

How To Use Postman To Test Api On Localhost

API Testing Blog

Getting Started with Postman for Localhost API Testing

Postman is a powerful tool for testing APIs, and it’s particularly useful when working with APIs running on your local machine. This guide will walk you through the essential steps of using Postman to test APIs on localhost, providing practical examples and code snippets along the way.

1. Understanding the Basics

Before diving into the specifics, let’s clarify the key components:

  • Localhost: This refers to your own computer, where you’re running the API server.
  • Postman: A user-friendly platform for building and sending API requests.
  • API Endpoint: The specific URL that the request will be sent to.

2. Setting up a Local API Server

For this guide, we’ll use a simple Node.js server with an express API. You can use any language or framework you prefer.

Code Example (Node.js)

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


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


app.listen(port, () => {
  console.log(`Server listening at http://localhost:${port}`);
});

Start your server by running node index.js (or the appropriate command for your setup).

3. Crafting Your First Request in Postman

Step 1: Install Postman

Download and install Postman from https://www.postman.com/.

Step 2: Launch Postman and Create a New Request

  1. Open Postman and click the “New” button to create a new request.
  2. From the drop-down menu, select “Request.”

Step 3: Configure the Request

  1. In the “Request” tab, fill in the following:
    • Method: Select the HTTP method (e.g., GET, POST, PUT, DELETE). For our example, this will be GET.
    • URL: Enter the API endpoint on your localhost. For this example, it will be http://localhost:3000/users.

Step 4: Send the Request and Analyze the Response

  1. Click the “Send” button.
  2. On the right side, you’ll see the response:
    • Status Code: Indicates the server’s response (e.g., 200 OK, 404 Not Found).
    • Headers: Information exchanged between client and server.
    • Body: The content returned by the API.

4. Working with Different API Method Types

Postman supports all common HTTP methods:

  • GET: Retrieves data from the server.
  • POST: Sends data to the server to create a new resource.
  • PUT: Updates an existing resource on the server.
  • DELETE: Removes a resource from the server.
  • PATCH: Partially updates an existing resource on the server.

Example: POST Request

Request Body:

{
  "name": "Alice Smith"
}

Postman Configuration:

  • Method: POST
  • URL: http://localhost:3000/users
  • Body: raw (JSON) and paste the JSON body.

Response:

You should receive a status code (e.g., 201 Created) and potentially a confirmation in the body.

5. Sending Data with Request Body

Many APIs require you to send data with your request. You can do this in Postman using the “Body” section:

Example: PUT Request (Updating a user)

Request Body:

{
  "id": 1,
  "name": "John Smith"
}

Postman Configuration:

  • Method: PUT
  • URL: http://localhost:3000/users/1 (Assuming the API takes an ID as part of the URL)
  • Body: raw (JSON) and paste the JSON body.

6. Using Environment Variables and Collections

Postman offers powerful features to organize your tests:

  • Environment Variables: Store dynamic values like hostnames, API keys, and database connection details. This makes it easy to switch between different environments (development, testing, production).
  • Collections: Group related requests together. This keeps your tests organized and allows you to execute multiple requests in a specific order.

7. Test Automation with Postman Scripts

Postman supports scripting with JavaScript to automate testing:

Example: Verifying a Status Code

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

This script will check if the response received from the API has a status code of 200 (OK). You can write more sophisticated scripts for various scenarios.

8. Conclusion

Postman is a versatile tool for testing APIs, particularly those hosted on your local machine. With its intuitive interface, diverse features, and scripting capabilities, you can effectively manage your API testing workflow. Remember to experiment, explore the features, and adapt your testing strategy based on your specific needs and project requirements.

API Testing Blog