Skip to content
Postman API Testing Tips

How To Use Json In Postman

API Testing Blog

Understanding JSON in Postman

JSON (JavaScript Object Notation) is a lightweight data-interchange format widely used in APIs. Postman, a popular API client, offers powerful features for working with JSON data during API testing. This guide will walk you through various aspects of using JSON in Postman, equipping you with the knowledge and skills to effectively utilize it for testing your APIs.

1. Sending JSON Data in Requests

Postman allows you to send JSON data in the request body for various HTTP methods, including POST, PUT, and PATCH. Here’s how to do it:

  1. Select the Request Body Tab: In the request builder, click on the “Body” tab.
  2. Choose “raw” and select “JSON” as the format: This ensures your data is interpreted correctly.
  3. Enter your JSON data: Here’s an example of a JSON payload:
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "age": 30
}
  1. Send the Request: Click “Send” to submit your request.

2. Parsing and Validating JSON Responses

Postman’s response body is also often in JSON format. You can easily parse and validate the response data to verify the API’s correctness.

Parsing JSON Data:

  1. Access the Response Body: After you send a request, the response body is displayed in the “Body” tab.
  2. Utilize the “Pretty” option (if needed): This formats the JSON into a more readable structure.
  3. Use the “Code” tab: Switch to the “Code” tab and select “JSON” as the format. This provides a structured view of your response, allowing you to easily access specific data points.

Validating JSON Data:

  1. Utilize the Test Tab: In Postman, the “Tests” tab provides a scripting environment where you can write assertions to validate the JSON response.
  2. Write Assertions: Use JavaScript code to check specific attributes, values, and data structures. Here’s an example of validating a response body:
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');
  pm.expect(pm.response.json().name).to.be.equal('John Doe');
});

3. Working with JSON Arrays

Postman also supports working with JSON arrays within requests and responses.

Sending Data in JSON Arrays:

  1. Use Square Brackets in the “raw” body: Enclose your JSON array elements within square brackets. For instance:
[
  {
    "id": 1,
    "name": "Product A"
  },
  {
    "id": 2,
    "name": "Product B"
  }
]

Validation in JSON Arrays:

  1. Iterate using the _.each method: You can loop through array elements using Lodash’s _.each method in your Postman tests.
// Assuming response contains an array called 'products'
_.each(pm.response.json().products, function (product) {
  pm.test("Product name is valid", function () {
    pm.expect(product.name).to.be.a('string');
  });
});

4. Utilizing Environment Variables with JSON

Postman allows you to use environment variables to dynamically configure data within your JSON requests and responses.

  1. Define Environment Variables: Go to the “Manage Environments” section in Postman and create environment variables.
  2. Utilize Variables in JSON: Replace hardcoded values in your JSON data with environment variables using double curly braces ({{ }}).

Example:

{
  "email": "{{userEmail}}",
  "password": "{{userPassword}}"
}

5. Advanced JSON Usage with Collections

Postman collections offer a powerful way to manage and organize multiple requests and tests for different API endpoints. You can leverage JSON in collections to further streamline your testing process.

  1. Define Shared Variables: Utilize collection variables to define common JSON data elements that can be used across multiple requests within the collection.
  2. Utilize Pre-request Scripts: Postman’s pre-request scripts, written in JavaScript, can dynamically modify your JSON payloads before sending requests. This is particularly useful for scenarios like data generation or dynamic data manipulation.
  3. Utilize Test Scripts: Similar to individual requests, you can use JSON validation techniques within test scripts for entire collections and manage complex workflows based on your JSON responses.

By integrating JSON into your collection’s structure, you can significantly improve the organization, reusability, and flexibility of your API tests within Postman.

6. External JSON Files for Data Management

Postman provides the flexibility of importing external JSON files for managing data, especially when dealing with large or complex data structures.

  1. Create an External JSON File: Store your JSON data in a separate file with a .json extension.
  2. Import the File: In the request builder’s “Body” tab, select “raw” and choose “JSON (from file)“. Browse to locate your external JSON file.
  3. Use the Imported Data: You can now utilize the data from your external JSON file in your request body or within your test scripts.

This approach offers greater organization and maintainability for your JSON data, particularly for scenarios involving large sets of data or complex data structures.

By mastering these techniques for working with JSON in Postman, you’ll be able to take advantage of its versatility and power in various API testing workflows. This will ensure your API tests are comprehensive, efficient, and effectively validate the behavior and data integrity of your APIs.

API Testing Blog