用途:读取 Express 路由文件,自动生成 OpenAPI 3.0 规范,用于 API 文档编写、Swagger UI 接入、API 消费者上手和 API-first 设计。
主要能力:解析 Express 路由定义,提取端点、HTTP 方法与处理函数代码;生成 OpenAPI 3.0 规范;记录请求与响应结构;输出可直接供 Swagger UI 使用。
使用方式:无需安装,直接用 npx 运行。示例:npx ai-swagger ./src/routes/ 从路由目录生成;npx ai-swagger ./src/routes/users.ts -o docs/api.yaml 针对单文件并指定输出路径;npx ai-swagger --help 查看帮助。
要求:推荐 Node.js 18+,需要设置 OPENAI_API_KEY 环境变量。
建议做法:路由变更后重新生成以保持更新;为端点补充说明;加入示例请求;除正常路径外也记录错误响应。
限制:资料未提供生成准确率、支持的路由写法范围、是否支持其他框架、输出格式细节及收费信息,仅说明为 MIT 许可、免费使用。