跳到主要内容
uencoder

JSON Schema

JSON Schema 是描述 JSON 文档结构的词汇表,定义类型、约束与验证规则,是 JSON 的 schema 标准。

用途

为 JSON 提供类似 XSD 的验证机制,确保数据符合预期结构。

机制

用 JSON 自身描述 schema:type 声明类型,properties 声明对象属性,items 声明数组元素,required 声明必填,minimum/maximum/pattern 等约束。 Draft 2020-12 为最新版本。验证器(ajv)据此验证。

用例

  • API 请求/响应验证
  • 配置文件校验
  • 表单数据验证
  • OpenAPI 类型定义

示例

  • 输入
    {"type":"object","properties":{"age":{"type":"integer","minimum":0}}}
    输出
    Validates that age is a non-negative integer

    Constraint declaration

常见错误

Using an outdated draft version breaks validator compatibility
Pin the draft version and use a matching validator

相关词条

相关工具

参考链接