Skip to content
Postman API Testing Tips

How To Test Odata Service Using Postman

API Testing Blog

Testing OData Services with Postman

OData (Open Data Protocol) is a standardized protocol for accessing and querying data. It allows you to interact with data sources like databases, cloud storage, etc., using HTTP methods and a well-defined syntax. Postman, a popular API testing tool, provides a powerful way to test OData services and ensure they function correctly. This guide will walk you through the process of testing OData services using Postman, including practical examples and step-by-step instructions.

Understanding OData Basics

Before diving into testing, it’s essential to understand the fundamental concepts of OData.

  • OData Endpoints: These are URLs that expose data resources.
  • Query Options: OData uses query options to filter, sort, and select data. Common options include $filter, $top, $skip, $orderby, etc.
  • HTTP Methods: The standard HTTP methods (GET, POST, PUT, DELETE) are used for data operations.

Setting up Postman for OData Testing

Step 1: Install Postman. You can download the app from https://www.postman.com/.

Step 2: Create a new request in Postman.

Step 3: Enter the OData endpoint URL in the request URL field. For example: http://services.odata.org/V4/TripPinServiceRW/People

Basic OData Operations with Postman

1. Retrieving Data (GET)

To retrieve data from an OData service, use the GET method.

Example:

Request:

GET http://services.odata.org/V4/TripPinServiceRW/People

Response: This will return a JSON response containing all the people from the OData service. You can use query options to filter and customize the data.

Example with Query Options:

Request:

GET http://services.odata.org/V4/TripPinServiceRW/People?$filter=FirstName eq 'Ruth'

Response: This will return only the person with the first name “Ruth.”

2. Creating Data (POST)

To create new data, use the POST method and provide the new data as JSON in the request body.

Example:

Request:

POST http://services.odata.org/V4/TripPinServiceRW/People
Content-Type: application/json


{
  "FirstName": "John",
  "LastName": "Doe",
  "UserName": "JohnDoe",
  "Emails": [
    {
      "Email": "john.doe@example.com"
    }
  ]
}

Response: The response will contain the newly created person’s information.

3. Updating Data (PATCH/PUT)

To update existing data, use the PATCH (for partial updates) or PUT (for full updates) methods.

Example (PATCH):

Request:

PATCH http://services.odata.org/V4/TripPinServiceRW/People(1)
Content-Type: application/json


{
  "FirstName": "Jane"
}

Response: The response will indicate if the update was successful.

4. Deleting Data (DELETE)

To delete data, use the DELETE method.

Example:

Request:

DELETE http://services.odata.org/V4/TripPinServiceRW/People(1)

Response: The response will indicate if the deletion was successful.

Advanced OData Testing Techniques

1. Testing Pagination:

  • Use the $top and $skip query options to verify the service handles pagination correctly.
  • Set $top to a specific value to limit the results.
  • Increment $skip to retrieve different pages of data.

2. Testing Filtering and Sorting:

  • Use the $filter and $orderby query options to test filtering and sorting functionality.
  • Verify that data is filtered and sorted as expected according to your criteria.
  • For complex filtering, use the $expand and $select query options to fetch related entities and specific fields.

3. Testing Data Validation:

  • Submit invalid data to ensure the service correctly validates input and returns appropriate error messages.
  • Use Postman’s built-in validation features to check if the response schema and data types match the OData metadata.

4. Testing Performance:

  • Use Postman’s performance testing features (e.g., load tests) to assess the service’s performance under various scenarios.
  • Monitor response times, latency, and throughput to identify bottlenecks.

5. Testing Authorization and Authentication:

  • Use Postman’s authentication features (e.g., Basic auth, OAuth) to test secured endpoints.
  • Verify that access is granted or denied based on the authentication configuration.

Creating Automated Tests with Postman Collections

Postman Collections allow you to organize and automate your OData tests.

1. Create a New Collection:

  • In Postman, click “Collections” and create a new collection for your OData tests.

2. Add Requests:

  • Add the requests you created in the previous sections to the collection.

3. Add Assertions:

  • Use the Postman Test tab to add assertions to your requests. Assertions help validate the responses and ensure the service behaves as expected.

Example Assertion:

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


pm.test("Body matches schema", function () {
    pm.expect(pm.response.json()).to.be.an('array');
});

4. Run Tests:

  • Run the collection to execute all tests within it.
  • Analyze the results to identify any failures or areas for improvement.

5. Share or Export:

  • You can share your collection with others or export it as a JSON or CSV file to maintain your tests.

Conclusion:

Postman offers a comprehensive platform for testing OData services. Using the techniques outlined above, you can perform thorough testing to ensure the reliability and functionality of your OData APIs. Remember to leverage the power of Postman’s features like Collections and Tests to automate your testing procedures and guarantee the quality of your services.

API Testing Blog