跳转到正文

JSON Schema 生成器

根据示例 JSON 生成 JSON Schema。生成器会推断类型、必填属性、数组项的 Schema,以及 date-time、email、uri 和 uuid 等常见字符串格式,并生成符合 draft 2020-12、2019-09 或 draft-07 的 Schema,可用于验证请求、编写 API 文档或生成表单。

重置

常见问题

支持哪些 JSON Schema 草案版本?

支持 draft 2020-12(OpenAPI 3.1 使用的当前版本)、draft 2019-09 和许多旧版验证器与工具仍要求使用的 draft-07。此选项会设置 $schema URL;生成器写入的关键字在这三个版本中的含义相同。

如何确定必填属性?

如果某个属性出现在该对象的每个样本中,就会列在 required 下。对于对象数组,如果某个键在部分项中缺失,就不会列入 required。关闭此选项即可生成不含任何 required 列表的 Schema。

会检测哪些字符串格式?

date-time、date、time、email、uri、uuid 和 ipv4。只有当该属性的每个样本值都符合某种格式时,才会添加该格式,因此只要有一个自由文本值,该属性就会保持为普通字符串。如果不想要格式关键字,可以关闭检测。

Schema 会区分整数和小数吗?

会。如果某个属性的所有样本值都是整数,其类型会设为 integer。只要有一个样本值包含小数部分,类型就会变为 number;number 同样接受整数。

如何描述数组?

数组会指定为 array 类型,并根据其中所有元素共同生成 items Schema。数组中的对象会合并,因此 items Schema 会列出任何元素中出现的所有键,而 required 只包含每个对象中都出现的键。

遇到混合类型时会怎样处理?

如果某个属性包含不同类型的简单值,例如某一项是字符串,另一项是 null,Schema 会将它们列为类型数组,例如 ["string", "null"]。如果对象或数组与其他类型混合,生成器会使用 anyOf,并为每种类型提供一个 Schema。

会添加 additionalProperties 或限制条件吗?

不会。示例无法说明哪些额外键应被禁止,也无法确定真实的最小值和最大值,因此生成器不会添加 additionalProperties、minLength、maximum 等关键字。请根据数据需求手动添加。

可以用生成结果验证数据吗?

可以。将 Schema 和数据粘贴到 JSON Schema Validator 中,或使用 Ajv 等库进行验证。请先检查 Schema:它反映的是你的示例,因此如果真实数据中的某个字段可能缺失或为 null,但示例中没有体现,就需要稍作修改。

可以在 OpenAPI 中使用此 Schema 吗?

OpenAPI 3.1 直接使用 JSON Schema 2020-12,因此移除 $schema 行后,可以将生成的架构放在 components/schemas 下。OpenAPI 3.0 使用较旧的子集;在这种情况下,请将类型数组替换为 nullable。

输入内容可以有多大?

最多可输入 1,000,000 个字符的 JSON,嵌套深度最多为 64 层。此示例仅针对本次请求进行分析,不会保存。

关于 OneClick Pro

OneClick Pro 是一个免费的工具集合,包含超过 150 种网络工具,助你处理日常工作:转换图像和单位、格式化和验证代码、检查域名和 SEO,以及处理文本、日期和数字。所有工具均可免注册、免订阅使用;你输入的内容仅用于计算结果,绝不会被存储。你可以将它用作处理临时任务的快捷工具箱,也可以收藏每天都会用到的工具。