JSON Schema 生成器

粘贴一条或多条示例 JSON,自动推断出 JSON Schema:合并多条记录判断哪些字段必填、哪些可能为 null,识别 email、日期时间、网址、UUID、IP 等格式以及取值固定的枚举。生成的 Schema 可以直接用于接口文档和数据校验,建议再按业务规则补充取值范围和说明。

生成之后还要做什么

  • 样本越多越准确:只有一条样本时,所有出现的字段都会被当成必填,可能为 null 或可省略的字段也无法判断。尽量提供包含各种情况的多条数据,例如有优惠券和没有优惠券的订单。
  • 补充业务规则:自动推断只知道类型,不知道“年龄在 0 到 150 之间”“状态只能是这几个值”。生成后补上 minimum、maximum、enum、pattern 等约束,以及 title、description 说明。
  • 检查识别出的格式:格式是根据样本推断的,如果某个字段的样本恰好都像网址但实际允许任意文本,请删掉 format。
  • OpenAPI 中使用:OpenAPI 3.1 完全兼容 JSON Schema 2020-12;OpenAPI 3.0 使用的是改写过的子集,不支持 type: ["string", "null"] 这种写法,要改成 nullable: true。

生成后可以在 JSON Schema 验证器 中校验数据,或用 JSON Schema 生成表单 预览表单;生成 TypeScript 类型请用 JSON 转 TypeScript。

JSON Schema 生成器常见问题

JSON Schema 生成器怎么使用?

粘贴一条示例 JSON,或者包含多条记录的数组(勾选“顶层数组的每一项作为一条样本”);选择 Schema 版本、必填字段的判断方式,按需开启格式识别、枚举识别、禁止多余字段、示例值和整数小数区分,右侧实时生成 Schema。

怎么根据 JSON 生成 Schema?

粘贴示例 JSON,右侧会自动生成对应的 JSON Schema。

多条样本有什么用?

可以判断哪些字段每条都有(必填)、哪些可能为 null,以及字段的取值范围和格式。

draft-07 和 2020-12 有什么区别?

2020-12 用 prefixItems 表示元组、用 $defs 代替 definitions,OpenAPI 3.1 使用 2020-12。

生成的 Schema 能直接用吗?

可以作为起点,建议补充 description、取值范围和枚举等业务规则。

JSON Schema 生成器的结果应怎样理解?

Schema 根据样本推断,样本越全面越准确;不会推断取值范围、长度等业务约束,需要手动补充。

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

示例数据只在浏览器本地处理,不会上传。

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

可选字段被标成了必填,说明所有样本中都有这个字段,增加缺少该字段的样本或把必填方式改为“不设置”。

相关工具

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