Skip to content
Postman API Testing Tips

How To Use Postman To Check Api Response

API Testing Blog

Getting Started with Postman for API Response Testing

Postman is a powerful tool for testing APIs and checking their responses. This guide will walk you through the process of using Postman for this purpose, providing practical examples and code snippets.

1. Setting Up Your Request

  • Choose the HTTP Method: Select the appropriate HTTP method (GET, POST, PUT, DELETE, etc.) based on the API endpoint you are testing.
  • Enter the URL: Input the complete URL of the API endpoint you want to test.
  • Add Headers (if required): If the API endpoint requires authorization headers, add them here. For example, for an API requiring an API key:
{
  "Authorization": "Bearer your_api_key"
}
  • Add Body (if applicable): If the API endpoint expects data in the request body, add it in the appropriate format (JSON, XML, etc.):
{
  "name": "John Doe",
  "email": "john.doe@example.com"
}

2. Sending the Request and Checking the Response

  • Click Send: Once you have set up your request, click the “Send” button to execute it.
  • Review the Response Status: In the response tab, check the Status Code to understand the server’s response. Common status codes include:
    • 200 OK: The request was successful.
    • 400 Bad Request: The request was invalid.
    • 401 Unauthorized: Authentication failed.
    • 404 Not Found: The requested resource was not found.
    • 500 Internal Server Error: An error occurred on the server side.
  • Inspect the Response Body: Examine the response body for the expected data. You can view it in different formats like raw text, JSON, or HTML.

3. Understanding Response Headers:

  • Content-Type: This header indicates the data type of the response body (e.g., application/json, text/html).
  • Content-Length: This header indicates the size of the response body in bytes.
  • Date: The date and time the server generated the response.
  • Server: The server software used to serve the API.

4. Testing API Responses with Assertions

Postman allows you to write assertions to validate the API response against specific expectations. Assertions are crucial for automated testing and ensure that your API behaves as intended.

  • Add Test Scripts: Click the “Tests” tab and write your test scripts using the built-in JavaScript engine.
  • Sample Assertion Code:
pm.test("Status code is 200", function () {
  pm.response.to.have.status(200);
});


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

Explanation:

  • pm.test("Test Description", function(){...}); defines a test with a descriptive name.
  • pm.response.to.have.status(200); checks if the response status code is 200.
  • pm.expect(pm.response.json().name).to.be.a('string'); checks if the ‘name’ property exists in the JSON response body and is a string.

5. Building Automated Tests

Postman supports building automated tests and workflows:

  • Collections: Organize your API requests into collections for efficient testing.
  • Environments: Define variables for different environments (development, testing, production) to manage API endpoints easily.
  • Runners: Run your collections with pre-defined iterations and variables for comprehensive testing.

Example: Testing a User Registration API

1. Request Setup:

  • HTTP Method: POST
  • URL: https://api.example.com/users
  • Headers: Content-Type: application/json
  • Body:
{
  "username": "testuser",
  "email": "test@example.com",
  "password": "password123"
}

2. Response Validation:

  • Test Script:
pm.test("Status code is 201 Created", function () {
    pm.response.to.have.status(201);
});


pm.test("Response body contains user data", function () {
    pm.expect(pm.response.json().username).to.equal("testuser");
    pm.expect(pm.response.json().email).to.equal("test@example.com");
});

3. Execution:

  • Send the Request: Click “Send.”
  • Review Results: Check the response tab for the status code and body. The tests will pass if the response matches the expectations.

Conclusion

Postman provides an intuitive and powerful platform for testing API responses. By understanding the basics of setting up requests, inspecting responses, and leveraging assertions, you can effectively validate your API’s behavior and ensure its quality. Utilizing collections, environments, and runners further enhances your testing process, enabling automated testing and streamlined workflows.

API Testing Blog