SuperAPI AI 工具集

openapi-to-typescript

编程与开发

查看项目

更新于 10-16 09:30

技能介绍

用途:把 OpenAPI 3.0.x 规范(JSON 或 YAML)转换成 TypeScript 接口与类型守卫,适合需要为已有 API 规范生成类型的场景。触发说法包括“generate types from openapi”“convert openapi to typescript”“create API interfaces”“generate types from spec”。

主要能力:从 components/schemas 提取模式生成 interface,从 paths 提取端点生成请求/响应类型(命名如 {Method}{Path}Request、{Method}{Path}Response);为每个主要接口生成 isXxx 类型守卫;始终输出 ApiError 与 isApiError。类型映射覆盖 string、number、integer、boolean、null;format 如 uuid、date、date-time、email、uri 保留为 string 并加注释;支持 object(required 字段无问号,可选字段带问号)、array、enum 联合、oneOf 联合、allOf 继承、$ref 直接引用不内联展开。使用 OpenAPI description 作为 JSDoc,文件头带来源与生成时间并标注勿手动编辑。

使用方式:先获取 OpenAPI 文件路径,读取并校验(openapi 字段须以 3.0 开头、须有 paths、有类型时须有 components.schemas,不合法则报错停止),再提取、生成、询问保存位置(默认 types/api.ts)并写入。

限制:仅支持 OpenAPI 3.0.x;$ref 找不到会列出缺失引用;未知类型用 unknown 并告警;循环引用用 type alias 惰性引用。资料未提供安装命令、收费与平台支持信息。