jest-json-schema
JSON schema matcher for jest
Matchers included
toMatchSchema(schema, [ajvOptions])
Validates that an object matches the given JSON schema
it('validates my json', () => {
const schema = {
properties: {
hello: { type: 'string' },
},
required: ['hello'],
};
expect({ hello: 'world' }).toMatchSchema(schema);
});
Referenced schemas will be automatically fetched if you use the async
option.
it('auto-fetches referenced schemas', async () => {
const schemaWithRefs = require('./schema-with-refs.json');
await expect({ hello: 'world' }).toMatchSchema(schemaWithRefs, {
async: true
});
});
Local schemas will be loaded via the filesystem by providing a resolutions
option, removing the need for them to be hosted at their schema URI.
it('auto-fetches referenced schemas', async () => {
const schemaWithRefs = require('./schema-with-refs.json');
await expect({ hello: 'world' }).toMatchSchema(schemaWithRefs, {
async: true,
resolutions: {
'http://my-domain.com/schema/': __dirname
}
});
});
toBeValidSchema([ajvOptions])
Validates that a schema is valid
it('validates my schema', () => {
const schema = {
properties: {
hello: { type: 'string' },
},
required: ['hello'],
};
expect(schema).toBeValidSchema();
});
Installation
$ npm install --save-dev jest-json-schema
Usage
In any test file:
import matchers from 'jest-json-schema';
expect.extend(matchers);
Or if you want it available for all test files then set it up the same way in a test framework script file
You can pass Ajv options as a
second parameter to any of the matchers. The only option passed by default is
allErrors: true
.
const ajvOptions = {
formats: {
bcp47: /^[a-z]{2}-[A-Z]{2}$/,
},
};
const schema = {
type: 'object',
properties: {
lang: {
type: 'string',
format: 'bcp47',
},
},
};
expect({ lang: 'en-US' }).toMatchSchema(schema, ajvOptions);
Contributing
We welcome Your interest in the American Express Open Source Community on Github. Any Contributor to any Open Source Project managed by the American Express Open Source Community must accept and sign an Agreement indicating agreement to the terms below. Except for the rights granted in this Agreement to American Express and to recipients of software distributed by American Express, You reserve all right, title, and interest, if any, in and to Your Contributions. Please fill out the Agreement.
License
Any contributions made under this project will be governed by the Apache License 2.0.
Code of Conduct
This project adheres to the American Express Community Guidelines. By participating, you are expected to honor these guidelines.