跳转到正文

OpenAPI 转 TypeScript

根据 YAML 或 JSON 格式的 OpenAPI 3 或 Swagger 2.0 文档中的 Schema 生成 TypeScript 类型。components.schemas 下的每个条目(或 Swagger 2.0 中的 definitions)都会变为导出的接口或类型别名;$ref 之间的引用会变为类型名称;可空字段会添加 | null。

重置

常见问题

文档中的哪些部分会被转换?

OpenAPI 3 中 components.schemas 下的 Schema,以及 Swagger 2.0 中 definitions 下的 Schema。路径、参数和响应不会转换为类型;请在自己的请求和响应代码中引用生成的 Schema 类型。

Schema 名称如何转换为类型名称?

每个 Schema 键都会重新构造为 PascalCase,因此 user-profile 会变为 UserProfile。如果两个键会生成相同名称,则会在第二个名称后追加数字。

支持可空字段吗?

支持。OpenAPI 3.0 中的 nullable: true 和 Swagger 2.0 中的 x-nullable: true 会添加 | null;OpenAPI 3.1 中的类型数组(如 ["string", "null"])会变为 string | null。

工具无法解析的引用会怎样处理?

指向文档外部或指向 components.schemas 或 definitions 中非 Schema 内容的 $ref,会变为 unknown,并列在输出顶部的注释中。

支持 YAML 吗?

支持。请将文档粘贴为 YAML 或 JSON。转换前会展开 YAML 中的锚点和别名。

如何先检查文档?

使用 OpenAPI 验证器,它会列出结构问题和失效引用。此转换器只读取 Schema,不会报告其他错误。

关于 OneClick Pro

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