ajv

Ajv JSON 模式验证器

适用于 Node.js 和浏览器的最快 JSON 验证器。

支持 JSON 模式 Draft-04/06/07/2019-09/2020-12（draft-04 支持需要 ajv-draft-04 包）和 JSON 类型定义 RFC8927。

AJV赞助商

贡献

超过 100 人为 Ajv 做出了贡献，我们很高兴您能加入到开发中。我们欢迎实施新功能，这将使许多用户受益，并提出改进我们文档的想法。

请查看贡献指南和代码组件。

文档

所有文档均可在 Ajv 网站上获取。

一些有用的网站链接：

• 入门
• JSON 架构与 JSON 类型定义
• API参考
• 严格模式
• 独立验证码
• 安全考虑
• 命令行界面
• 常见问题解答

请赞助 Ajv 开发

自从我请求支持 Ajv 开发以来，已有 40 个人和 6 个组织通过 GitHub 和 OpenCollective 做出了贡献 - 这种支持有助于获得 MOSS 资助！

您的持续支持非常重要 - 一旦下一个主要版本发布，资金将用于开发和维护 Ajv。

请通过以下方式赞助 Ajv：

• GitHub 赞助商页面（GitHub 会匹配）
• AJV 开放集体

谢谢。

开放集体赞助商

表现

Ajv 生成代码将 JSON 模式转换为超快速的验证函数，对 v8 优化非常有效。

根据这些基准，目前 Ajv 是最快、最符合标准的验证器：

• json-schema-benchmark - 比第二名快 50%
• jsck 基准测试 - 快 20-190%
• z 模式基准测试
• 忒弥斯基准

json-schema-benchmark 不同验证器的性能：

特征

• Ajv实现JSON Schema Draft-06/07/2019-09/2020-12标准（v6支持draft-04）：
  • 所有验证关键字（请参阅 JSON 架构验证关键字）
  • OpenAPI 扩展：
    • 新：关键字鉴别器。
    • 关键字可为空。
  • 完全支持远程引用（远程模式必须使用addSchema添加或编译才能使用）
  • 支持模式之间的递归引用
  • 具有 unicode 对的字符串的正确字符串长度
  • JSON 模式格式（带有 ajv-formats 插件）。
  • 根据元模式验证模式
• 新功能：支持 JSON 类型定义：
  • 所有关键字（请参阅 JSON 类型定义架构表单）
  • JTD 模式的元模式
  • “union”关键字和用户定义的关键字（可以在模式的“元数据”成员内部使用）
• 支持浏览器和 Node.js 10.x - 当前
• 编译期间异步加载引用的模式
• 带有选项 allErrors 的“所有错误”验证模式
• 带有描述错误原因的参数的错误消息，以允许生成错误消息
• ajv-i18n 包支持 i18n 错误消息
• 删除附加属性
• 为缺失的属性和项目分配默认值
• 将数据强制转换为type关键字中指定的类型
• 用户定义的关键字
• 带有 ajv-keywords 包的附加扩展关键字
• $data 引用，使用已验证数据中的值作为架构关键字的值
• 用户定义的格式和关键字的异步验证

安装

要安装版本 8：

 npm install ajv

入门

在 Node.js REPL 中尝试一下：https://runkit.com/npm/ajv

在 JavaScript 中：

 // or ESM/TypeScript import
import Ajv from "ajv"
// Node.js require:
const Ajv = require ( "ajv" )

const ajv = new Ajv ( ) // options can be passed, e.g. {allErrors: true}

const schema = {
  type : "object" ,
  properties : {
    foo : { type : "integer" } ,
    bar : { type : "string" } ,
  } ,
  required : [ "foo" ] ,
  additionalProperties : false ,
}

const data = {
  foo : 1 ,
  bar : "abc" ,
}

const validate = ajv . compile ( schema )
const valid = validate ( data )
if ( ! valid ) console . log ( validate . errors )

了解如何使用 Ajv 并查看指南中的更多示例：入门

更改历史记录

请参阅 https://github.com/ajv-validator/ajv/releases

请注意：8.0.0 版本中的更改

版本7.0.0

版本 6.0.0。

行为守则

请查看并遵守行为准则。

请将任何不可接受的行为报告给 [email protected] - 项目团队将对其进行审核。

安全联系人

要报告安全漏洞，请使用 Tidelift 安全联系人。 Tidelift 将协调修复和披露。请不要通过 GitHub 问题报告安全漏洞。

开源软件支持

Ajv 是 Tidelift 订阅的一部分 - 除了软件维护人员提供的支持之外，它还为开源软件用户提供集中支持。

执照

麻省理工学院