JSON Schema 验证器

用 JSON Schema 校验 JSON 数据,逐条列出不符合要求的字段路径、对应的 Schema 位置和中文错误说明。支持 draft-07、2019-09、2020-12 的常用关键字和文档内的 $ref 引用,也可以把数组中的每条记录分别校验。数据只在浏览器本地处理。

示例:

常用关键字速查

关键字作用
type类型:string、number、integer、boolean、object、array、null,可以写成数组表示多种类型
required对象中必须存在的字段名列表
properties、additionalProperties各字段的规则;additionalProperties 为 false 时不允许出现未声明的字段
enum、const只能是列出的值之一 / 必须等于某个值
minLength、maxLength、pattern、format字符串长度、正则、格式(email、date、date-time、uri、ipv4、ipv6、uuid 等)
minimum、maximum、exclusiveMinimum、multipleOf数值范围和倍数
items、prefixItems、minItems、uniqueItems、contains数组元素的规则、元组、数量、去重和包含
allOf、anyOf、oneOf、not同时满足全部 / 至少一个 / 恰好一个 / 不能满足
if、then、else条件规则,例如支付方式为银行卡时必须填写卡号
$ref、$defs引用其他位置定义的规则,避免重复(draft-07 中写作 definitions)
  • format 默认只是注解:按规范,format 在多数校验器中默认不强制检查(Ajv 需要安装 ajv-formats),本工具默认检查,可以取消勾选。
  • 不支持的内容:外部文件的 $ref、$dynamicRef、unevaluatedProperties 等高级关键字不会生效,正式项目请使用 Ajv(JavaScript)、jsonschema(Python)等完整实现。

没有 Schema 时,可以用 JSON Schema 生成器 从示例数据生成;想直观填写数据,可以用 JSON Schema 生成表单。

JSON Schema 验证器常见问题

JSON Schema 验证器怎么使用?

左侧粘贴 JSON Schema,右侧粘贴要校验的 JSON 数据,或点击示例;下方实时列出每处不符合要求的数据位置、中文说明和对应的 Schema 位置;数据是数组时可以勾选逐条校验。

什么是 JSON Schema?

描述 JSON 数据结构和取值规则的规范,用来校验接口参数、配置文件和数据。

required 和 additionalProperties 有什么区别?

required 规定哪些字段必须存在,additionalProperties 为 false 时不允许出现未声明的字段。

format 为什么没有生效?

按规范 format 默认只是注解,本工具默认会校验,可以取消勾选。

支持 draft-07 吗?

支持 draft-07、2019-09 和 2020-12 的常用关键字。

JSON Schema 验证器的结果应怎样理解?

支持常用关键字和文档内的 $ref;外部文件引用、$dynamicRef、unevaluatedProperties 等高级关键字不会生效。

输入内容会保存或发给外部服务吗?

Schema 和数据只在浏览器本地校验,不会上传。

没有结果或操作失败时先检查什么?

提示 Schema 有问题时,检查 $ref 引用的路径是否存在;正则 pattern 写法错误也会导致校验失败。

相关工具

JSON Schema 生成表单 · JSON 对比 · JSON 补丁工具 · JSON Schema 生成器 · 全部开发工具