Skip to content
Postman API Testing Tips

How To Use Postman Chrome Extension

API Testing Blog

A Comprehensive Guide to Using the Postman Chrome Extension for API Testing

Postman is an invaluable tool for testing APIs, and its Chrome extension adds convenience and accessibility. Here’s a detailed guide on how to effectively leverage the Postman Chrome extension for your API testing needs.

1. Installation and Getting Started

Installation:

  1. Downloading: Access the Chrome Web Store and search for “Postman.”
  2. Adding to Chrome: Click “Add to Chrome” and accept the permissions.
  3. Launching: The Postman extension icon will appear in your Chrome toolbar.

Initial Setup:

  1. Login: If you have an existing Postman account, log in. Otherwise, create a free account.
  2. Workspace: Choose a workspace or create a new one to organize your API tests.

2. Building Requests with the Postman Chrome Extension

Creating Requests:

  1. Launch: Click the Postman icon in your Chrome toolbar.
  2. New Request: Click the “New” button and select “Request.”
  3. Request Details:
    • Method: Select the HTTP method (GET, POST, PUT, DELETE, etc.).
    • URL: Enter the API endpoint you want to test.
    • Headers: Add any required headers (e.g., Authorization, Content-Type).
    • Body: Define the request body if necessary.

Example: Sending a GET Request to a Weather API

// Request Details
Method: GET
URL: https://api.openweathermap.org/data/2.5/weather?q=London&appid=YOUR_API_KEY
Headers:
 - Key: Accept
   Value: application/json


// Sample Response (JSON)
{
  "coord": {
    "lon": -0.1257,
    "lat": 51.5074
  },
  "weather": [
    {
      "id": 800,
      "main": "Clear",
      "description": "clear sky",
      "icon": "01d"
    }
  ],
  "base": "stations",
  "main": {
    "temp": 282.55,
    "feels_like": 278.9,
    "temp_min": 280.37,
    "temp_max": 284.26,
    "pressure": 1012,
    "humidity": 64
  },
  "visibility": 10000,
  "wind": {
    "speed": 4.6,
    "deg": 310
  },
  "clouds": {
    "all": 0
  },
  "dt": 1696041651,
  "sys": {
    "type": 1,
    "id": 1414,
    "country": "GB",
    "sunrise": 1696017997,
    "sunset": 1696059668
  },
  "timezone": 3600,
  "id": 2643743,
  "name": "London",
  "cod": 200
}

Request Body Formatting:

  • JSON: Use the “Raw” tab and select “JSON” for sending and receiving data in JSON format.
  • Form Data: Use the “Form Data” tab for sending data in key-value pairs.
  • Binary: Use the “Binary” tab for sending files.

Example: Sending a POST Request to a To-Do API

// Request Details
Method: POST
URL: https://api.example.com/todos
Headers:
 - Key: Content-Type
   Value: application/json


// Request Body (JSON)
{
  "task": "Buy groceries",
  "completed": false
}


// Sample Response (JSON)
{
  "id": 123,
  "task": "Buy groceries",
  "completed": false
}

Testing Your Requests:

  • Send: Click the “Send” button to execute the request.
  • Response: The response from the API will be displayed in the “Response” tab.
  • Validation: Examine the response status code, headers, and body to ensure the API is functioning correctly.

3. Organizing Requests with Collections

Collections: A collection is a group of requests that are related to a specific API or functionality.

Creating Collections:

  1. New Collection: Click the “New” button and select “Collection.”
  2. Name: Provide a relevant name for the collection.
  3. Add Requests: Click the “Add Request” button to add requests within the collection.

Advantages of Collections:

  • Organization: Keep related API requests together.
  • Reusability: Avoid repetitive request creation.
  • Documentation: Provide context for your API tests.

4. Automating Tests with Postman Scripts

Scripts: Postman scripts allow you to automate tasks, validate responses, and perform complex testing scenarios.

Script Locations:

  • Pre-request Script: Executed before sending a request.
  • Test Script: Executed after receiving a response.

Example: Validating API Response with a Test Script

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


pm.test("Response body contains task", function () {
  pm.response.to.have.body("Buy groceries");
});

Postman Scripting Language:

  • JavaScript: The scripting language used in Postman is JavaScript.
  • pm Object: Provides access to Postman’s API for interacting with requests, responses, and variables.

5. Advanced Features for API Testing

Environments: Sets of variables that can be used in your requests and scripts.

Example: Using Environments for API Key Management

  • Create an environment named “Production” and define a variable called “apiKey” with the value of your production API key.
  • Create another environment named “Staging” and define the same “apiKey” variable with the staging API key.

Running Collections with Environments:

  1. Select environment: Choose the environment you want to use before running the collection.
  2. Run Collection: Use the “Run” button to execute the collection, utilizing the selected environment variables.

Mock Servers: Simulate API responses for testing without relying on a real backend.

6. Postman Chrome Extension vs Postman App

Chrome Extension:

  • Lightweight: Ideal for quick testing on the fly.
  • Limited Features: Offers fewer advanced features compared to the desktop application.

Postman App:

  • Comprehensive: Full suite of features for API testing.
  • Offline Access: Work offline with your collections and environments.

Best Practice: Use the Chrome Extension for Quick Tasks and the Desktop App for Complex Projects.

This guide provides a comprehensive overview of how to use the Postman Chrome extension for API testing. By mastering these fundamental techniques, you can streamline your API testing process, improve code quality, and ensure the reliability of your web applications.

API Testing Blog