A chai plugin for validate json schema.
npm install chai-json-schema-ajv
A chai plugin for validate json schema.
This is based on ajv, a JSON schema Validator.
|version|ajv version|json schema version|
|---|---|---|
|v1|4.11.8|JSON Schema draft 4|
|v2|5.5.2|JSON Schema draft-06|
|v3|^6.7.0|JSON Schema draft-07|
|v4|>=4 <7||
|v5|>=4 <7|Same as v4, but different message format|
|v5.2|>=4||
``shnpm i ajv@4 --save-dev
npm i ajv --save-dev # Or any version you prefer
npm i chai-json-schema-ajv --save-dev
`js
const chai = require('chai')
chai.use(require('chai-json-schema-ajv'))
const expect = chai.expect
const assert = chai.assert
const apple = {
name: 'foo',
color: ['red', 'green', 'yellow'],
value: 10
}
const car = {
name: 'bar',
speed: 1.1
}
const schema = {
title: 'fruit schema v0.1',
type: 'object',
required: ['name', 'color', 'value'],
properties: {
name: {
type: 'string',
minLength: 3
},
color: {
type: 'array',
minItems: 1,
uniqueItems: true,
items: {
type: 'string'
}
},
value: {
type: 'integer',
minimum: 5
}
}
}
expect(apple).to.be.jsonSchema(schema, 'custom flag')
expect(car).to.not.be.jsonSchema(schema, 'custom flag')
assert.jsonSchema(apple, schema, 'custom flag')
assert.notJsonSchema(car, schema, 'custom flag')
`
`js
const chai = require('chai')
chai.use(require('chai-json-schema-ajv'))
const expect = chai.expect
const assert = chai.assert
const schema = {
title: 'valid schema',
type: 'object',
required: ['name'],
properties: {
name: {
type: 'string',
minLength: 3
}
}
}
expect(schema, 'custom flag').to.be.validJsonSchema
expect({ type: '__invalid__' }, 'custom flag').to.not.be.validJsonSchema
assert.validJsonSchema(schema, 'custom flag')
assert.notValidJsonSchema({ type: '__invalid__' }, 'custom flag')
`
Options will also pass to ajv
`js
...
const options = { ... }
chai.use(
require('chai-json-schema-ajv').create(options)
)
...
// Basically, it's same as new Ajv(options)
#### Option verbose
Default error message is parsed by ajv.errorsText.
`js`
...
chai.use(
require('chai-json-schema-ajv')
)
...
`console`
expected data to match json-schema
data should have required property 'color'
If you go with option {verbose: true}, it will print full errors.
`js`
...
chai.use(
require('chai-json-schema-ajv').create({
verbose: true
})
)
...
`console`
expected { name: 'bar', speed: 1.1 } to match json-schema
[ { keyword: 'required',
dataPath: '',
schemaPath: '#/required',
params: { missingProperty: 'color' },
message: 'should have required property \'color\'',
schema:
{ name: { type: 'string', minLength: 3 },
color:
{ type: 'array',
minItems: 1,
uniqueItems: true,
items: { type: 'string' } },
value: { type: 'integer', minimum: 5 } },
parentSchema:
{ title: 'fruit schema v0.1',
type: 'object',
required: [ 'name', 'color', 'value' ],
properties:
{ name: { type: 'string', minLength: 3 },
color:
{ type: 'array',
minItems: 1,
uniqueItems: true,
items: { type: 'string' } },
value: { type: 'integer', minimum: 5 } } },
data: { name: 'bar', speed: 1.1 } } ]
#### Option ajv
If you want to reuse ajv instance, you can
`js
const ajv = new Ajv
...
chai.use(
require('chai-json-schema-ajv').create({
ajv
})
)
...
assert.ok(ajv === chai.ajv)
`
`js
...
chai.use(
require('chai-json-schema-ajv')
)
...
assert.ok(chai.ajv instanceof Ajv)
``
- Support browser side
- Move to es2017 async/await
- ~~Add linter~~
- ~~Send option to ajv~~ (thanks @dimac)
MIT