jc21 / cypress-swagger-validation

Validate your request responses against Swagger JSON Endpoints. AKA Contract Testing.

📙 Some of my open source projects

🔥 Streak stats

📊 GitHub Profile Stats

📊 Recent GitHub Activity

---

Made with ❤️ by Pius Walter and affectionately stolen by jc21

cypress-swagger-validation's Issues

Problems integrating with Cypress LTS

Thanks for the work that you've been doing with this lib. I'm testing out a couple of OAS validator libs to integrate with our Cypress tests and I'm having some troubles integrating yours with Cypress 13.5.0 - was wondering if you can help out.

The format for cypress.config.ts changed itm and following your example:

import {expect, use} from "chai";
const {SwaggerValidation} = require('@jc21/cypress-swagger-validation');

export default defineConfig({
    screenshotOnRunFailure: false,
    env: {
        hideCredentials: true,
    },
    e2e: {
        baseUrl: 'https://api.stg.thousandeyes.com',
        setupNodeEvents(on, config) {
            on('task', {
                 SwaggerValidation(config){
                    return config;
                },
                 otherTask(){}

simply states that validateSwaggerSchema does not exist. I also tried putting everything in the test, without success:

describe('API Test', () => {
    it.only('should satisfy OpenAPI spec', () => {
        MyEndpoint.getAll().then((response) => {
            const config = {
                file:                 'path.to.yaml.file', 
                endpoint:       '/v7/account-groups',
                method:         'GET',
                statusCode:     200,
                responseSchema: response.body,
                verbose:        true,                     
            }
            // cy.task('validateSwaggerSchema', config).should('equal', null);
            SwaggerValidation(config).validateSwaggerSchema(config)
        });
    });
});

Do you have any idea what I'm doing wrong?

Validate intercepts

Hi and thanks for the nice plugin!
I wanted to share an idea of validating intercepts with the openapi schema.

Kind of like:

beforeEach(() => {
    cy.intercept('*', req => {
        req.continue(res => {
            cy.task('validateSwaggerSchema', {
                file: './../swagger.json',
                endpoint: req.url,
                method: req.method,
                statusCode: res.statusCode,
                responseSchema: res.body,
                verbose: true // optional, default: false
            }).should('equal', null);
        });
    });
});

This example does not work because of cypress-io/cypress#7667

This would ensure fixtures (e.g. cy.intercept('GET', '/api/identity', { fixture: 'identity/sys-admin.json'})) are still adhering to the schema.