How to validate API response vs schema - spryker-projects/cypress-boilerplate GitHub Wiki

Overview

Validating API responses against a schema ensures that the responses from your API are in the expected format and adhere to the predefined structure.

Why Schema Validation is Needed

Schema validation in Cypress tests helps to:

• Ensure Data Consistency: Verify that the API response structure is consistent with the defined schema, preventing unexpected changes or issues.
• Catch Errors Early: Identify deviations from the expected schema format, which can indicate bugs or integration issues.
• Improve Test Reliability: Provide a clear, structured approach to validating API responses, reducing the likelihood of false positives or negatives in tests.

How to Validate API Responses Against a Schema

1. Define Your Schema

The schema should describe the expected structure of your API response. For example, you can find the defined schema

• in the checkout-response.ts
• in the access-tokens-response.ts

2. Implement the Schema Validation Helper

The validateSchema function, implemented in api-helpers.ts, is used to validate the API response against the schema that described in the constants checkoutSchema and validateSchema.

3. Use the validateSchema function to validate the API responses against the schemas.

In your test file, you can implement the validation as follows:

import { validateSchema } from '@support/api-helper/api-helper'
import checkoutSchema from '@support/glue-endpoints/checkout/checkout-response'

describe('API Response Validation', () => {
  it('should match the checkout schema', () => {
    cy.request('GET', '/api/checkout')
      .should((response) => {
        expect(response.status).to.eq(200);
        validateSchema(checkoutSchema, response);
      });
  });
});

As an example of using schema validation, you can check implemented validation of

• Access Token response
• Checkout Response

4. Run Your Tests

Execute your Cypress tests as usual. The schema validation will ensure that the API responses conform to the expected structure.

Conclusion

Validating API responses against schemas is a critical step in ensuring the reliability and consistency of your API. By incorporating schema validation into your Cypress tests, you can catch errors early, improve test accuracy, and maintain the integrity of your API responses.