Skip to content
Postman API Testing Tips

How To Test Json Using Postman

API Testing Blog

Testing JSON with Postman: A Comprehensive Guide

Postman is a powerful tool for API testing, and it excels at handling JSON data. This guide will walk you through testing various aspects of JSON using Postman, from simple validation to complex assertions.

1. Sending JSON Data with Postman

Postman allows you to send JSON data to your API endpoints in a straightforward manner.

Step 1: Create a new request in Postman.

Step 2: Choose the appropriate HTTP method (POST, PUT, PATCH, etc.).

Step 3: Set the Content-Type header to application/json.

Step 4: In the body section, select raw and choose JSON as the format.

Step 5: Input your JSON data.

Example:

{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "age": 30
}

Step 6: Send the request and review the response.

2. Validating JSON Response with Postman

Postman’s built-in test features make it easy to validate the JSON response returned by your API.

Step 1: Go to the “Tests” tab of your request.

Step 2: Write your test scripts using Postman’s built-in pm object.

Step 3: Use pm.response.json() to access the JSON response data.

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


pm.test("Response body should have a 'name' property", function () {
  pm.expect(pm.response.json().name).to.be.a('string');
});

3. Assertions and Validation with Chai.js

Postman provides built-in support for Chai.js, a popular JavaScript assertion library. Chai’s functionalities allow for more detailed and expressive assertions.

Step 1: Add chai.js to your Postman environment.

Step 2: Import Chai library using const chai = require('chai');

Step 3: Use chai.expect to perform various assertions.

const chai = require('chai');
const expect = chai.expect;


pm.test("Response body should have a 'name' property", function () {
  expect(pm.response.json().name).to.be.a('string');
});


pm.test("Response body should have an age property that is a number", () => {
  expect(pm.response.json().age).to.be.a('number');
});


pm.test("Email should be a valid email address", () => {
  expect(pm.response.json().email).to.match(/^\S+@\S+\.\S+$/);
});

4. Testing JSON Schema with Postman

JSON Schema is a powerful tool for defining the structure and content of JSON data. Postman’s JSON Schema validator allows you to compare your API responses against a predefined schema for stricter validation.

Step 1: Define your JSON Schema in a separate file (e.g., schema.json).

Step 2: Create a new test in Postman and import your schema file.

const schema = require('./schema.json');
pm.test("Response body should match the schema", function () {
  pm.expect(pm.response.json()).to.matchSchema(schema);
});

Example Schema:

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "email": { "type": "string", "format": "email" },
    "age": { "type": "integer", "minimum": 18 }
  },
  "required": ["name", "email", "age"]
}

5. Testing JSON Arrays with Postman

Postman seamlessly integrates with JSON arrays. You can test the elements within these arrays using similar methods to single objects.

Example:

pm.test("Response should include an array of users", function () {
  pm.expect(pm.response.json().users).to.be.an('array');
});


pm.test("The first user in the array should have a name property", function () {
  pm.expect(pm.response.json().users[0].name).to.be.a('string');
});

6. Testing JSON Nested Objects with Postman

Postman allows you to traverse JSON objects, including nested ones, to test specific data points.

pm.test("Response should have a nested 'address' object", function () {
  pm.expect(pm.response.json().address).to.be.an('object');
});


pm.test("The address object should have a 'street' property", function () {
  pm.expect(pm.response.json().address.street).to.be.a('string');
});

7. Using Postman Collections for Efficient JSON Testing

Postman collections allow for organizing and streamlining your API tests, particularly for scenarios involving multiple related requests or complex flows.

Step 1: Create a new Postman collection.

Step 2: Add your relevant API requests to the collection.

Step 3: Add tests to each request.

Step 4: Use the collection runner to execute all tests within the collection.

Postman collections significantly improve the organization of your tests and enable streamlined execution, especially when dealing with larger projects and complicated workflows involving JSON data.

By following these steps, you can effectively test JSON data within your API using Postman, ensuring the accuracy, structure, and content of your JSON responses. This comprehensive guide provides a practical foundation for your API testing journey with Postman. Remember that Postman’s extensive features and customization options enable you to adapt these methods to meet the specific requirements of your API projects and ensure the reliability of your JSON data.

API Testing Blog