A fast and easy to use JSON Schema validator
JSON schema validator, which is designed to be fast and simple to use. The latest IETF published draft is v4, this library is mostly v4 compatible.
Please fork the repository, make the changes in your fork and include tests. Once you're done making changes, send in a pull request.
Please include a test which shows why the code fails.
Simple object validation using JSON schemas.
var Validator = require'jsonschema'Validator;var v = ;var instance = 4;var schema = "type": "number";console.logvvalidateinstance schema;
var validate = require'jsonschema'validate;console.logvalidate4 "type": "number";
var Validator = require'jsonschema'Validator;var v = ;// Address, to be embedded on Personvar addressSchema ="id": "/SimpleAddress""type": "object""properties":"lines":"type": "array""items": "type": "string""zip": "type": "string""city": "type": "string""country": "type": "string""required": "country";// Personvar schema ="id": "/SimplePerson""type": "object""properties":"name": "type": "string""address": "$ref": "/SimpleAddress""votes": "type": "integer" "minimum": 1;var p ="name": "Barack Obama""address":"lines": "1600 Pennsylvania Avenue Northwest""zip": "DC 20500""city": "Washington""country": "USA""votes": "lots";vaddSchemaaddressSchema '/SimpleAddress';console.logvvalidatep schema;
For a comprehensive, annotated example illustrating all possible validation options, see examples/all.js
All schema definitions are supported, $schema is ignored.
All types are supported
All formats are supported, phone numbers are expected to follow the E.123 standard.
The first error found will be thrown as an
Error object if
true. Otherwise all results will be appended to the
result.errors array which also contains the success flag
Specify your own JSON Schema properties with the validator.attributes property:
validatorattributescontains =iftypeof instance!='string' return;iftypeof schemacontains!='string' throw '"contains" expects a string' schema;ifinstanceindexOfschemacontains<0return 'does not contain the string ' + JSONstringifyschemacontains;var result = validatorvalidate"i am an instance" type:"string" contains: "i am" ;// result.valid === true;
The instance passes validation if the function returns nothing. A single validation error is produced
if the fuction returns a string. Any number of errors (maybe none at all) may be returned by passing a
ValidatorResult object, which may be used like so:
var result = instance schema options ctx;whilesomeErrorConditionresultaddError'fails some validation test';return result;
Sometimes you may want to download schemas from remote sources, like a database, or over HTTP. When importing a schema,
unknown references are inserted into the
validator.unresolvedRefs Array. Asynchronously shift elements off this array and import
var Validator = require'jsonschema'Validator;var v = ;vaddSchemainitialSchema;var nextSchema = vunresolvedRefsshift;if!nextSchema done; return;databaseGetnextSchemavaddSchemaschema;importNextSchema;;importNextSchema;
Uses JSON Schema Test Suite as well as our own tests. You'll need to update and init the git submodules:
git submodule update --init npm test
This library would not be possible without the valuable contributions by:
... and many others!
jsonschema is licensed under MIT license. Copyright (C) 2012-2015 Tom de Grunt <firstname.lastname@example.org> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.