JSON Schema 生成器

JSON Schema 生成器计算器可将样本 JSON 转换为适用于 API、webhook、配置文件、数据管道和文档的、可随时用于验证器的 Schema。只需粘贴具有代表性的 JSON 对象、数组或 NDJSON 源，选择推断样式，该工具就会构建一个包含嵌套属性、数组项规则、可空值、示例和清晰的逐路径说明的 Schema。

为什么要使用基于样本的 JSON Schema 生成器？

纯手工编写 JSON Schema 固然精准，但速度较慢，特别是当数据包含嵌套对象、记录数组、可选字段和可空值时。该生成器可以为您提供一个捕获了 JSON 数据所观察到形状的结构化初稿，然后突出显示仍需要人工审查的地方。它对于 API 请求验证、响应契约、OpenAPI 工作、webhook 负载、事件流和配置 Schema 极为有用。

如何使用

1. 将具有代表性的 JSON 对象、JSON 数组或换行符分隔的 JSON（NDJSON）记录粘贴到样本编辑器中。
2. 选择 JSON Schema 草案版本，并决定是否推断必填字段、示例、枚举（enum）提示、字符串格式和关闭对象。默认情况下，草案版本为 Draft 2020-12，必填字段设置为“在每个对象中均有出现”，检测格式、包含示例和推断枚举（enum）提示处于开启状态，关闭对象处于关闭状态。Schema 标题默认为 GeneratedSchema。
3. 点击“生成 JSON Schema”来推断类型、嵌套属性、数组项、可空字段和验证提示。
4. 在使用 Schema 之前，检查生成的映射图以查看每个路径、推断的类型、必填状态、格式和规则。
5. 复制生成的 Schema 并精简特定于领域的验证规则，例如精确范围、ID 模式和特定于业务的枚举（enum）。

生成器推断的内容

• 核心 JSON 类型：object、array、string、number、integer、boolean 和 null。
• 基于在每个被观察对象中出现的内容来推断嵌套对象属性和必填字段。
• 通过合并样本中观察到的项来推断数组项 Schema。
• 常见的字符串格式，包括 email、URL、date、date-time、UUID、IPv4 和 IPv6。
• 可选示例、枚举（enum）提示、观察到的数字范围和观察到的字符串长度。

常见问题

这个 JSON Schema 生成器是做什么的？

它读取样本 JSON 并创建一个描述所观察到的数据形状的 JSON Schema。该生成器可以推断对象属性、数组、原始类型、可空值、示例、枚举（enum）提示、必填字段以及常见的字符串格式。

生成的 Schema 可以立即在生产环境中使用吗？

可以将其作为一个强有力的起点，然后进行审查。样本 data 无法获知所有的业务规则，因此您可能仍然需要添加模式（pattern）、精确范围、允许的枚举值、版本规则以及更严格的 additionalProperties 设置。

支持哪些 JSON Schema 草案版本？

该工具可以通过设置 $schema URI 来为 Draft 2020-12、Draft 2019-09 和 Draft-07 生成 Schema。推断出的结构有意与常见的验证器保持兼容。

必填字段是如何推断的？

当启用必填项推断时，只有当某个属性出现在该层级的每个被观察到的对象中时，它才会被标记为必填。对于对象数组，这意味着该字段必须出现在每个采样项中。

该工具是否支持对象数组和 NDJSON？

是的。顶级的 JSON 数组将被视为数组 Schema，而换行符分隔的 JSON（NDJSON）记录将被视为记录数组。项属性会从观察到的样本中进行合并。