SuperAPI AI 工具集

api-documentation-generator

编程与开发

查看项目

更新于 10-15 16:45

技能介绍

用途:扫描代码库中的 API 路由定义,自动生成或更新 OpenAPI 3.0 规范文件(openapi.yaml 或 swagger.json)。适用于用户请求生成 API 文档、处理 REST 端点、需要创建或更新 Swagger 规范,以及为 Express、FastAPI、Flask、NestJS 等框架建立文档时。

主要能力:发现路由(如 app.get()、@app.get()、@app.route()、@Get() 等,并用 Glob 查找路由文件);分析 HTTP 方法、路径、路径/查询参数、请求体、响应结构、认证要求与附近注释;映射为 OpenAPI 路径对象,用 JSON Schema 定义请求/响应结构,添加参数、认证方案(Bearer、API Key、OAuth2)并按标签分组;校验完整性(所有端点、错误响应、安全要求等)。

使用方式:先用 Glob 找出路由文件,再逐条提取路由信息,基于模板 templates/openapi-3.0.yaml 生成规范,保存到项目根目录或 docs/、api/ 目录。框架相关:Express 检查中间件、验证器与 JSDoc;FastAPI 提取 Pydantic 模型和 response_model;NestJS 查找 DTO 与 Swagger 装饰器。

建议:复用现有类型定义、补充请求/响应示例、按资源分组、使用代码中的版本号、用注释作描述。限制:具体命令、安装方式、收费与价格信息暂未提供。