Skip to content
Postman API Testing Tips

How To Use Jsonpath In Postman

API Testing Blog

Leveraging JSONPath in Postman for Efficient API Testing

JSONPath is a powerful tool for navigating and extracting data from JSON documents. When it comes to API testing, Postman integrates seamlessly with JSONPath, enabling you to validate responses, build dynamic requests, and streamline your testing workflow. This guide will equip you with the knowledge and practical examples to master JSONPath within Postman.

Understanding JSONPath Syntax

JSONPath expressions are similar to XPath for XML documents, allowing you to target specific elements within your JSON response. Here’s a breakdown of common syntax:

  • Root Element: $ represents the root of the JSON document.
  • Child Elements: Use a dot (.) to access child elements. For example, $.name retrieves the value of the “name” property at the root level.
  • Arrays: Use square brackets ([]) to access elements within arrays. $[0] selects the first element, $[1] the second, and so on. You can also use ranges (e.g., $[1:3]) or filter expressions within the square brackets.
  • Wildcards: The asterisk (*) acts as a wildcard, matching any property name or array element.

Extracting Data with JSONPath in Postman

Postman allows you to use JSONPath expressions directly within your tests. Here’s a step-by-step guide:

  1. Send a Request: Execute an API request that returns JSON data.
  2. Add a Test: In the “Tests” tab of your request, create a new test using the pm.test() function.
  3. Utilize JSONPath: Within your test, use the pm.response.json() method to access the JSON response. Then, apply JSONPath to extract specific data.

Example:

pm.test("Verify customer name", function () {
    var customerName = pm.response.json().name;
    pm.expect(customerName).to.be.equal("John Doe");
});

This test verifies that the customer’s name in the response is “John Doe.”

Using JSONPath in Assertions

JSONPath is essential for robust API testing as it allows you to make assertions about various aspects of your responses.

Example:

pm.test("Check if order status is 'processed'", function () {
    var orderStatus = pm.response.json().order.status;
    pm.expect(orderStatus).to.be.equal("processed");
});


pm.test("Verify product price is within range", function () {
    var productPrice = pm.response.json().product.price;
    pm.expect(productPrice).to.be.above(10).and.below(100);
});


pm.test("Check for specific error code", function () {
    var errorCode = pm.response.json().error.code;
    pm.expect(errorCode).to.be.equal(404);
});

Dynamically Building Requests with JSONPath

JSONPath isn’t limited to data extraction and validation; it can also help build dynamic API requests.

Example:

var userId = pm.response.json().user.id; // Extract user ID from previous response
pm.sendRequest({
    url: 'https://api.example.com/users/' + userId,
    method: 'GET'
}, function (err, res) { // Handle the response
    if (err) {
        console.log(err);
    } else {
        console.log(res.text());
    }
});

This snippet dynamically sets the URL of a new GET request using the user ID extracted from a previous response.

Utilizing JSONPath for Complex Scenarios

JSONPath offers flexibility for handling complex JSON structures.

Example:

pm.test("Check if all cart items have valid prices", function () {
    var cartItems = pm.response.json().cart.items;
    cartItems.forEach(function(item) {
        pm.expect(item.price).to.be.above(0);
    });
});

This test iterates through an array of cart items and ensures each item has a valid price.

Summary

Mastering JSONPath in Postman empowers you to craft comprehensive and effective API tests. By leveraging its syntax, you can confidently extract, validate, and dynamically manipulate JSON data, boosting your testing efficiency and confidence in API functionality.

API Testing Blog