<img align="right" alt="Ajv logo" width="160" src="http://epoberezkin.github.io/ajv/images/ajv_logo.png">
# Ajv: Another JSON Schema Validator
The fastest JSON Schema validator for node.js and browser with draft 6 support.
[![Build Status](https://travis-ci.org/epoberezkin/ajv.svg?branch=master)](https://travis-ci.org/epoberezkin/ajv)
[![npm version](https://badge.fury.io/js/ajv.svg)](https://www.npmjs.com/package/ajv)
[![npm downloads](https://img.shields.io/npm/dm/ajv.svg)](https://www.npmjs.com/package/ajv)
[![Code Climate](https://codeclimate.com/github/epoberezkin/ajv/badges/gpa.svg)](https://codeclimate.com/github/epoberezkin/ajv)
[![Coverage Status](https://coveralls.io/repos/epoberezkin/ajv/badge.svg?branch=master&service=github)](https://coveralls.io/github/epoberezkin/ajv?branch=master)
[![Greenkeeper badge](https://badges.greenkeeper.io/epoberezkin/ajv.svg)](https://greenkeeper.io/)
[![Gitter](https://img.shields.io/gitter/room/ajv-validator/ajv.svg)](https://gitter.im/ajv-validator/ajv)
## Using version 5
[JSON Schema draft-06](https://trac.tools.ietf.org/html/draft-wright-json-schema-validation-01) is published.
[Ajv version 5.0.0](https://github.com/epoberezkin/ajv/releases/tag/5.0.0) that supports draft-06 is released. It may require either migrating your schemas or updating your code (to continue using draft-04 and v5 schemas).
__Please note__: To use Ajv with draft-04 schemas you need to explicitly add meta-schema to the validator instance:
```javascript
ajv.addMetaSchema(require('ajv/lib/refs/json-schema-draft-04.json'));
```
## Contents
- [Performance](#performance)
- [Features](#features)
- [Getting started](#getting-started)
- [Frequently Asked Questions](https://github.com/epoberezkin/ajv/blob/master/FAQ.md)
- [Using in browser](#using-in-browser)
- [Command line interface](#command-line-interface)
- Validation
- [Keywords](#validation-keywords)
- [Formats](#formats)
- [Combining schemas with $ref](#ref)
- [$data reference](#data-reference)
- NEW: [$merge and $patch keywords](#merge-and-patch-keywords)
- [Defining custom keywords](#defining-custom-keywords)
- [Asynchronous schema compilation](#asynchronous-schema-compilation)
- [Asynchronous validation](#asynchronous-validation)
- Modifying data during validation
- [Filtering data](#filtering-data)
- [Assigning defaults](#assigning-defaults)
- [Coercing data types](#coercing-data-types)
- API
- [Methods](#api)
- [Options](#options)
- [Validation errors](#validation-errors)
- [Related packages](#related-packages)
- [Packages using Ajv](#some-packages-using-ajv)
- [Tests, Contributing, History, License](#tests)
## Performance
Ajv generates code using [doT templates](https://github.com/olado/doT) to turn JSON schemas into super-fast validation functions that are efficient for v8 optimization.
Currently Ajv is the fastest and the most standard compliant validator according to these benchmarks:
- [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark) - 50% faster than the second place
- [jsck benchmark](https://github.com/pandastrike/jsck#benchmarks) - 20-190% faster
- [z-schema benchmark](https://rawgit.com/zaggino/z-schema/master/benchmark/results.html)
- [themis benchmark](https://cdn.rawgit.com/playlyfe/themis/master/benchmark/results.html)
Performace of different validators by [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark):
[![performance](https://chart.googleapis.com/chart?chxt=x,y&cht=bhs&chco=76A4FB&chls=2.0&chbh=32,4,1&chs=600x416&chxl=-1:%7Cajv%7Cis-my-json-valid%7Cjsen%7Cschemasaurus%7Cthemis%7Cz-schema%7Cjsck%7Cjsonschema%7Cskeemas%7Ctv4%7Cjayschema&chd=t:100,68,61,22.8,17.6,6.6,2.7,0.9,0.7,0.4,0.1)](https://github.com/ebdrup/json-schema-benchmark/blob/master/README.md#performance)
## Features
- Ajv implements full JSON Schema [draft 6](http://json-schema.org/) and draft 4 standards:
- all validation keywords (see [JSON Schema validation keywords](https://github.com/epoberezkin/ajv/blob/master/KEYWORDS.md))
- full support of remote refs (remote schemas have to be added with `addSchema` or compiled to be available)
- support of circular references between schemas
- correct string lengths for strings with unicode pairs (can be turned off)
- [formats](#formats) defined by JSON Schema draft 4 standard and custom formats (can be turned off)
- [validates schemas against meta-schema](#api-validateschema)
- supports [browsers](#using-in-browser) and nodejs 0.10-7.x
- [asynchronous loading](#asynchronous-schema-compilation) of referenced schemas during compilation
- "All errors" validation mode with [option allErrors](#options)
- [error messages with parameters](#validation-errors) describing error reasons to allow creating custom error messages
- i18n error messages support with [ajv-i18n](https://github.com/epoberezkin/ajv-i18n) package
- [filtering data](#filtering-data) from additional properties
- [assigning defaults](#assigning-defaults) to missing properties and items
- [coercing data](#coercing-data-types) to the types specified in `type` keywords
- [custom keywords](#defining-custom-keywords)
- draft-6 keywords `const`, `contains` and `propertyNames`
- draft-6 boolean schemas (`true`/`false` as a schema to always pass/fail).
- keywords `switch`, `patternRequired`, `formatMaximum` / `formatMinimum` and `formatExclusiveMaximum` / `formatExclusiveMinimum` from [JSON-schema extension proposals](https://github.com/json-schema/json-schema/wiki/v5-Proposals) with [ajv-keywords](https://github.com/epoberezkin/ajv-keywords) package
- [$data reference](#data-reference) to use values from the validated data as values for the schema keywords
- [asynchronous validation](#asynchronous-validation) of custom formats and keywords
Currently Ajv is the only validator that passes all the tests from [JSON Schema Test Suite](https://github.com/json-schema/JSON-Schema-Test-Suite) (according to [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark), apart from the test that requires that `1.0` is not an integer that is impossible to satisfy in JavaScript).
## Install
```
npm install ajv
```
## <a name="usage"></a>Getting started
Try it in the node REPL: https://tonicdev.com/npm/ajv
The fastest validation call:
```javascript
var Ajv = require('ajv');
var ajv = new Ajv(); // options can be passed, e.g. {allErrors: true}
var validate = ajv.compile(schema);
var valid = validate(data);
if (!valid) console.log(validate.errors);
```
or with less code
```javascript
// ...
var valid = ajv.validate(schema, data);
if (!valid) console.log(ajv.errors);
// ...
```
or
```javascript
// ...
ajv.addSchema(schema, 'mySchema');
var valid = ajv.validate('mySchema', data);
if (!valid) console.log(ajv.errorsText());
// ...
```
See [API](#api) and [Options](#options) for more details.
Ajv compiles schemas to functions and caches them in all cases (using schema serialized with [json-stable-stringify](https://github.com/substack/json-stable-stringify) or a custom function as a key), so that the next time the same schema is used (not necessarily the same object instance) it won't be compiled again.
The best performance is achieved when using compiled functions returned by `compile` or `getSchema` methods (there is no additional function call).
__Please note__: every time validation function or `ajv.validate` are called `errors` property is overwritten. You need to copy `errors` array reference to another variable if you want to use it later (e.g., in the callback). See [Validation errors](#validation-errors)
## Using in browser
You can require Ajv directly from the code you browserify - in this case Ajv will be a part of your bundle.
If you need to use Ajv in several bundles you can create a separate UMD bundle using `npm run bundle` script (thanks to [siddo420](https://github.com/siddo420)).
Then you need to load Ajv in the browser:
```html
<script src="ajv.min.js"></script
没有合适的资源?快使用搜索试试~ 我知道了~
node-v8.9.1.tar.gz
需积分: 10 9 下载量 35 浏览量
2017-11-13
09:52:38
上传
评论
收藏 29.66MB GZ 举报
温馨提示
共13638个文件
js:5076个
h:1645个
c:1075个
node-v8.9.1.tar.gz node.js v8.9.1 源码 API文档 包含:src,doc,lib,test, tools等文件夹 MD5:7482b2523f72000d1b6060c38945026b 大小: 29.6 MB
资源推荐
资源详情
资源评论
收起资源包目录
node-v8.9.1.tar.gz (13638个子文件)
npm-install.1 18KB
node.1 10KB
libnpx.1 7KB
npx.1 7KB
npm.1 6KB
npm-README.1 5KB
npm-doctor.1 5KB
npm-version.1 5KB
npm-update.1 4KB
sshpk-conv.1 4KB
npm-outdated.1 4KB
npm-token.1 4KB
npm-profile.1 3KB
npm-view.1 3KB
npm-search.1 3KB
npm-adduser.1 3KB
npm-dist-tag.1 3KB
npm-run-script.1 3KB
npm-publish.1 3KB
npm-cache.1 3KB
npm-access.1 3KB
npm-link.1 3KB
npm-ls.1 3KB
sshpk-sign.1 2KB
sshpk-verify.1 2KB
marked.1 2KB
npm-team.1 2KB
npm-uninstall.1 2KB
npm-config.1 2KB
npm-dedupe.1 1KB
npm-unpublish.1 1KB
npm-logout.1 1KB
npm-owner.1 1KB
npm-docs.1 1KB
npm-init.1 1KB
npm-bugs.1 1KB
npm-edit.1 1KB
npm-help.1 1KB
npm-explore.1 1KB
npm-restart.1 964B
npm-help-search.1 928B
npm-completion.1 919B
npm-shrinkwrap.1 864B
npm-prune.1 855B
npm-pack.1 840B
npm-deprecate.1 827B
npm-repo.1 775B
npm-install-test.1 757B
npm-start.1 745B
npm-build.1 641B
npm-prefix.1 621B
npm-star.1 546B
npm-ping.1 542B
npm-stars.1 541B
npm-rebuild.1 467B
npm-bin.1 414B
npm-bundle.1 412B
npm-root.1 409B
npm-test.1 407B
npm-stop.1 386B
npm-whoami.1 375B
zlib.3 4KB
npm-json.5 27KB
package.json.5 27KB
npm-folders.5 8KB
npm-global.5 8KB
npm-package-locks.5 6KB
package-lock.json.5 6KB
npmrc.5 3KB
npm-shrinkwrap.json.5 1KB
npm-config.7 35KB
semver.7 15KB
npm-scripts.7 10KB
npm-developers.7 8KB
npm-disputes.7 6KB
npm-coding-style.7 6KB
npm-scope.7 5KB
npm-index.7 4KB
npm-registry.7 4KB
npm-orgs.7 3KB
removing-npm.7 2KB
configure.ac 4KB
ACKNOWLEDGMENTS 87B
address 673B
Makefile.am 17KB
Makefile.am 2KB
Makefile.am 1KB
Makefile.android 3KB
android-configure 2KB
android-configure 603B
android-configure 540B
LICENSE.APACHE2 586B
LICENSE.APACHE2 586B
LICENSE.APACHE2 586B
LICENSE.APACHE2 586B
sha256-mb-x86_64.asm 154KB
sha1-mb-x86_64.asm 152KB
sha256-586.asm 120KB
sha1-x86_64.asm 101KB
sha256-x86_64.asm 93KB
共 13638 条
- 1
- 2
- 3
- 4
- 5
- 6
- 137
资源评论
sugarTan
- 粉丝: 158
- 资源: 563
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- IMG_2976.jpg
- cesiumVersionChanges1.117
- MI4953-VB一款SOP8封装2个P-Channel场效应MOS管
- MI4946-VB一款SOP8封装2个N-Channel场效应MOS管
- MI4904-VB一款SOP8封装2个N-Channel场效应MOS管
- 企业数字化转型顶层设计与企业架构TOGAF 9.2
- 01-basic-sample-20220716164705
- Serial Port Utility(1).zip
- MI4825-VB一款SOP8封装P-Channel场效应MOS管
- 基于Django实现配置管理系统 资产管理系统源码+在线演示+运行说明.zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功