跳转到正文

JSON Schema 转 TypeScript

将 JSON Schema 转换为 TypeScript 类型。对象会变为包含必填和可选属性的接口;$defs 和 definitions 会变为命名导出,供 $ref 引用;enum 和 const 会变为字面量类型;anyOf 和 oneOf 会变为联合类型,allOf 会变为交叉类型。描述会保留为文档注释。

重置

常见问题

支持哪些 JSON Schema 草案版本?

转换器会读取 draft-07、2019-09 和 2020-12 共用的关键字:type、properties、required、additionalProperties、items、prefixItems、enum、const、anyOf、oneOf、allOf,以及 $ref 到 $defs 或 definitions。minLength 或 pattern 等验证关键字没有对应的 TypeScript,因此会被忽略。

如何解析 $ref 引用?

指向 #、#/$defs/Name 和 #/definitions/Name 的引用会变为对应定义的命名类型。其他引用,例如指向另一个文件或 URL 的引用,会标记为 unknown,并列在输出顶部的注释中。

如何处理 additionalProperties?

没有属性但带有 additionalProperties Schema 的对象会变为 Record<string, T>。带有属性和 additionalProperties Schema 的对象会变为接口与 Record<string, T> 的交叉类型。additionalProperties 为 false 或缺少该关键字时不会添加任何内容,因为 TypeScript 对象类型已经描述了已知键。

nullable 有什么作用?

OpenAPI 3.0 的 nullable: true 关键字和 Swagger 的 x-nullable 扩展会在类型中添加 | null。在 JSON Schema 本身中,写入 type: ["string", "null"],它会变为 string | null。

支持递归 Schema 吗?

支持。通过 $ref 引用自身或另一个定义的定义,会变为引用另一个名称的命名类型,TypeScript 可以顺利解析这种类型。

它会检查我的 Schema 是否有效吗?

它只读取 Schema。未知关键字会被忽略,没有 type 的 Schema 会变为 unknown。使用 JSON Schema 验证器检查数据是否符合 Schema。

关于 OneClick Pro

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