SuperAPI AI 工具集

openapi-generator

编程与开发

查看项目

更新于 10-16 03:16

技能介绍

用途:从现有 API 代码库自动生成 OpenAPI 3.0/3.1 规范,支持 Express、Next.js、Fastify、Hono、NestJS 等框架的路由。

主要能力:扫描路由定义;提取类型、请求/响应体与参数;将路由转换为 OpenAPI path 对象;由类型生成 component schema;补充描述、示例与标签;导出 YAML 或 JSON。提供 TypeScript 类型到 OpenAPI schema 的转换逻辑、Express 路由与 JSDoc 元数据扫描、路径与默认响应生成、通用 schema 组件(Error、Pagination、User 等),以及 Fastify(@fastify/swagger、@fastify/swagger-ui)和 NestJS(@nestjs/swagger)集成示例。

使用方式:资料给出 CLI 脚本示例,命令名为 openapi-gen,选项包括 -f/--framework(express|nextjs|fastify,默认 express)、-s/--source(默认 ./src)、-o/--output(默认 ./openapi.yaml)、-t/--title、-v/--version、--json。另提供基于 @apidevtools/swagger-parser 的校验脚本。

适用场景:为已有 Node.js/TypeScript API 补充或维护 OpenAPI 文档,生成客户端 SDK 前的规范准备,以及接入 Swagger UI/Redoc 展示。

限制:资料未提供该技能的安装命令、包名、版本、收费与平台信息;示例代码为示意实现,实际扫描与生成逻辑需自行补全;未说明对非上述框架的支持情况。