Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

@jc21/cypress-jsonschema-validation

Package Overview
Dependencies
5
Maintainers
1
Versions
1
Issues
File Explorer

Advanced tools

@jc21/cypress-jsonschema-validation

Validate your data against JSON Schema

    0.0.1latest

Version published
Maintainers
1
Yearly downloads
6,292
increased by557.47%

Weekly downloads

Readme

Source

Cypress JSON Schema Validation Plugin

Validate data payload against a given JSON Schema.

npm (scoped) npm (types) npm (licence)

Cypress Installation

yarn add @jc21/cypress-jsonschema-validation

Then in your cypress Plugins file:

const {JsonSchemaValidation} = require('@jc21/cypress-jsonschema-validation'); module.exports = (on, config) => { // ... on('task', JsonSchemaValidation(config)); // ... return config; };

Cypress Usage

describe('Basic API checks', () => { it('Should return a valid health payload', function () { cy.request('/healthz').then($response => { cy.task('validateJsonSchema', { data: $response.body, verbose: true, // optional, default: false schemaFile: './testing/schema.json', // path or full URL, see below // Or you can also define the schema inline: schema: { "type": "object", "properties": { "id": { "type": "integer" } } }, }).should('equal', null); }); }); });

The Schema

You can provide the schemaFile or the schema. One of these options is required and using both will cause an error.

The schemaFile can either be a file on disk or a URL. When using a file on disk and due to the fact that this plugin runs on the Cypress Backend, the location of the file must be defined as either the full path on disk or relative path to the running of the cypress command.

Options

OptionDescriptionOptionalDefault
schemaFileThe location of the schema file to use for validationwhen schema provided
schemaSchema to use for validation. Cannot be used with schemaFilewhen schemaFile provided
dataThe payload to validate
verboseConsole.log more info when validation failstruefalse

Compiling Source

yarn install yarn build yarn test

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc