Skip to content
Postman API Testing Tips

How To Test A Rest Web Service Using Postman

API Testing Blog

Understanding RESTful APIs and Postman

RESTful APIs, short for Representational State Transfer, are a popular architectural style for building web services. They rely on standard HTTP methods like GET, POST, PUT, DELETE, and PATCH to interact with resources. Postman is a powerful tool that simplifies API testing by providing a user-friendly interface for sending requests, inspecting responses, and managing API documentation.

Setting Up Postman for API Testing

  1. Download and Install Postman: Visit the Postman website (https://www.postman.com/) and download the app for your operating system.

  2. Create a New Request: Open Postman and click on the “New” button or press “Ctrl+N”. Select “Request”.

  3. Define the Request Method: Choose the appropriate HTTP method (GET, POST, PUT, DELETE, PATCH, etc.) from the dropdown.

  4. Enter the Request URL: In the “Enter request URL” field, type the URL of the REST API endpoint you want to test.

Sending Requests and Inspecting Responses

  1. Add Request Headers (Optional): Click on the “Headers” tab to add any necessary headers, such as Content-Type or Authorization.

  2. Construct the Request Body (if needed): For methods like POST, PUT, and PATCH, you’ll typically provide data in the request body.

    • Form Data: For key-value pairs, use the “Form Data” tab.

    • JSON: For structured data, use the “Body” tab and select “raw” with “JSON (application/json)” as the content type. Paste your JSON payload:

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

  3. Send the Request: Click on the “Send” button to execute the request.

  4. Examine the Response: Postman will display the response in various tabs:

    • “Body”: Contains the response data.
    • “Headers”: Shows the response headers.
    • “Cookies”: Displays any cookies received in the response.
    • “Test”: Allows you to write code to perform assertions and validations.

Practical Example: Testing a GET Request

Let’s test a simple GET request to fetch a list of users from a hypothetical API:

1. Set Up the Request:

  • Method: GET
  • URL: https://api.example.com/users

2. Send the Request: Click “Send”.

3. Inspect the Response:

  • Body: Should contain a JSON array of user objects.
  • Headers: Should include information about the response, such as the content type.

Testing with Assertions and Validations

Postman’s “Tests” tab is crucial for verifying the API’s behavior. You can write code (using JavaScript or other languages) to perform assertions and validate the response data.

  1. Access the Response: Use the pm object to access response data using properties like pm.response.json() (for JSON responses) and pm.response.text() (for text responses).

  2. Write Assertions: Use pm.test() to define assertions.

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

     pm.test("Response body has users", function () {
       pm.response.json().length.to.be.above(0);
     });
    

     pm.test("Specific user exists", function () {
       var users = pm.response.json();
       var userFound = users.find(user => user.id === 123);
       pm.expect(userFound).to.not.be.undefined;
     });

Testing Different API Endpoints

Postman allows you to organize and manage test requests for various API endpoints.

  1. Collections: Create collections to group related tests.
  2. Environments: Define environments to store variables (like API keys or base URLs) that can be used across multiple requests.
  3. Variables: Use variables to make your tests more dynamic and reusable.

Example: Testing a POST Request with a JSON Body

  1. Set Up the Request:

    • Method: POST
    • URL: https://api.example.com/users
    • Headers:
      • Content-Type: application/json
    • Body: (JSON) 
      {
          "name": "Jane Doe",
          "email": "jane.doe@example.com"
      }

  2. Send the Request: Click “Send”.

  3. Inspect the Response:

    • Body: Should contain details of the newly created user.
    • Headers: Should include information like the newly assigned ID (if any).
    pm.test("Status code is 201", function () {
      pm.response.to.have.status(201);
    });
    

    pm.test("Response body includes name", function () {
      pm.expect(pm.response.json().name).to.equal("Jane Doe");
    });

Automated Testing with Postman Collections

Postman collections empower you to automate API testing by running a series of requests in a defined order.

  1. Add Requests to Collection: Drag and drop requests into a collection or create them directly within the collection.

  2. Run the Collection: Use the “Run” button to execute all requests in the collection.

  3. Reporting and Monitoring: Postman provides detailed reports and the ability to integrate with tools like Jenkins for continuous integration and monitoring.

Best Practices for Effective API Testing

  • Plan Your Tests: Define a clear testing strategy focused on specific scenarios.
  • Prioritize Endpoints: Test critical endpoints with high usage.
  • Use Assertions: Validate data consistency and expected outcomes.
  • Document Tests: Clearly describe the purpose of each test.
  • Automate Where Possible: Employ Postman’s collection features for repeated testing.

By leveraging Postman’s capabilities, you can ensure the quality of your RESTful APIs through comprehensive testing, validation, and automation.

API Testing Blog