Validate JSON based on JSON Schema files.
$ npm i --save @bpmn-io/json-schema-validatorGiven
import { Validator } from '@bpmn-io/json-schema-validator';
import schema from './test/fixtures/json-schema/schema.json';
import sample from './test/fixtures/samples/invalid-name.json';
const validator = new Validator({
schema: schema
});
const {
valid,
errors
} = validator.validate(sample);
if (!valid) {
console.error('Invalid JSON detected:', errors);
}This will print detailed information about errors inside the sample
[
{
"message": "must start with <number_>",
"keyword": "errorMessage",
"dataPath": "/properties/0/name",
"dataPointer": {
"key": { "line": 5, "column": 6, "pos": 97 },
"keyEnd": { "line": 5, "column": 12, "pos": 103 },
"value": { "line": 5, "column": 14, "pos": 105 },
"valueEnd": { "line": 5, "column": 19, "pos": 110 }
},
"schemaPath": "#/properties/properties/items/allOf/0/then/properties/name/errorMessage",
"params": {
"rawErrors": [
{
"keyword": "pattern",
"dataPath": "/properties/0/name",
"schemaPath": "#/properties/properties/items/allOf/0/then/properties/name/pattern",
"params": {
"pattern": "^(number_)"
},
"message": "should match pattern \"^(number_)\""
}
]
}
}
]It's also possible to validate multiple objects at once
import Validator from '@bpmn-io/json-schema-validator';
import schema from './test/fixtures/json-schema/schema.json';
import samples from './test/fixtures/samples/multiple-samples.json';
const validator = new Validator({
schema: schema
});
const {
valid,
results
} = validator.validateAll(samples);
if (!valid) {
console.error('Invalid JSON objects detected:', results.filter(r => !r.valid));
}MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent