Skip to content
Postman API Testing Tips

How To Use Postman For Json

API Testing Blog

Postman: Your JSON API Testing Toolkit

Postman is a powerful tool for working with APIs, and its capabilities are especially useful when dealing with JSON data. Here’s a comprehensive guide to mastering JSON API testing with Postman:

Sending JSON Requests with Postman

Postman allows you to send various types of HTTP requests, including GET, POST, PUT, DELETE, and more. When working with JSON, you’ll primarily use the POST request type for sending data to the API.

Step 1: Create a New Request

  • Click the “New” button in the Postman interface.
  • Choose “Request” from the dropdown menu.
  • Change the HTTP method to POST.
  • Enter the target API URL. For example, you might use https://api.example.com/users.

Step 2: Set the Request Body

  • Switch to the “Body” tab.
  • Select raw and choose JSON from the dropdown menu.
  • Paste or type your JSON payload.

Example:

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

Step 3: Send the Request

  • Click the “Send” button.
  • Examine the response in the “Body” tab to verify the API’s response.

Working with JSON Responses

Postman excels at handling and analyzing JSON responses. Here’s how you can work with them effectively:

1. Viewing JSON Data:

  • The response will be displayed directly in the “Body” tab as formatted JSON.
  • Postman automatically highlights syntax, making it easy to read and understand complex structures.

2. Using the Pretty Print Feature:

  • Clicking the “Pretty” button in the response viewer will beautify the JSON, making it more readable.

3. JSON Validator:

  • Postman has a built-in validator. Simply paste your JSON code into the “Body” tab and click the “Validate” button. This helps identify syntax errors.

Sending JSON Data in a POST Request

Step 1: Create a New Request (POST)

  • Follow the steps above to create a new request with the HTTP method set to POST.

Step 2: Add Headers:

  • In the “Headers” tab, add a header named Content-Type and set its value to application/json. This informs the API that you’re sending JSON data.

Step 3: Define the Request Body:

  • Switch to the “Body” tab.
  • Select “raw” and choose “JSON” from the dropdown menu.
  • Enter your JSON data.

Example:

{
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "age": 25
}

Step 4: Send the Request:

  • Click the “Send” button.
  • Inspect the response to confirm successful submission and verify any returned data.

Using Environment Variables with JSON

Environment variables provide a powerful way to manage and reuse your data throughout your API tests.

Step 1: Create an Environment:

  • Go to the “Environments” section in Postman.
  • Click the “Add” button to create a new environment.
  • Give your environment a name (e.g., “My API Test Environment”).

Step 2: Add Variables:

  • Go to “Variables” in your environment.
  • Click the “Add” button.
  • Enter a variable name (e.g., “apiUrl”) and a value (e.g., “https://api.example.com”).

Step 3: Use Variables in Requests:

  • In the request URL or the JSON body, use curly braces ({}) to reference environment variables. For example: {{apiUrl}}/users.
{
     "name": "Jane Doe",
     "email": "jane.doe@example.com",
     "age": {{userAge}}
}

Step 4: Select the Environment:

  • Before sending your request, select the environment you’ve created.

Testing with Assertions

Postman allows you to test your API responses using assertions. Assertions can verify that the response:

  • Has a specific status code: This ensures the API call was successful (e.g., 200 for success, 404 for not found).
  • Returns the correct data: You can check for specific values or data structures in the response.
  • Matches expected patterns: You can use regular expressions to verify data formats.

Step 1: Create a Test Suite:

  • In the “Tests” tab, enter JavaScript code for your assertions.

Step 2: Write Assertions:

  • Use Postman’s built-in functions like pm.test to define assertions.

Example:

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


pm.test("Response has the correct name", function () {
    pm.expect(pm.response.json().name).to.eql("John Doe");
});

Step 3: Run Tests:

  • Send your request to trigger the tests, and see the results in the “Tests” tab.

Using Collections to Organize Tests

Postman Collections are a way to group related API requests and tests together.

Step 1: Create a Collection:

  • In the “Collections” section, click the “Add” button to create a new collection.
  • Give your collection a name (e.g., “User API Tests”).

Step 2: Add Requests:

  • Click on the collection you just created.
  • Click the “Add Request” button.
  • Select the type of request (GET, POST, PUT, etc.).
  • Enter your API URL and any necessary parameters.
  • Save the request to the collection.

Step 3: Add Tests:

  • Select the request in the collection.
  • Switch to the “Tests” tab and write your assertions.

Step 4: Run the Collection:

  • You can run all requests within a collection sequentially using the “Run” button in the collection view.

Conclusion

Postman is an indispensable tool for API testing, especially when working with JSON data. By following these guidelines you can streamline your API testing workflow, improve the efficiency and reliability of your API operations, and deliver high-quality software.

API Testing Blog