api-doc-generatorlisted

# API 文档生成器 > **版本**: 2.0.0 | **最新更新**: 2025-12-10 ## 🚀 快速导航 ### 我应该使用这个 skill 吗？ **✅ 使用场景**: - 为REST API项目生成OpenAPI 3.0规范 - 创建或更新API接口文档 - 从代码自动提取API信息 - 生成Swagger UI可用的文档 - 同步代码与文档 **❌ 不使用场景**: - 仅需要查看现有文档 → 直接阅读 - GraphQL API → 使用GraphQL专用工具 - 非HTTP API（如gRPC）→ 使用对应工具 ### 快速开始 (3步) ```yaml 步骤1: 扫描代码库 → 使用 Grep 查找路由定义 → 使用 Glob 定位API文件 步骤2: 分析API端点 → 提取HTTP方法、路径、参数、schema 步骤3: 生成文档 → 使用 OPENAPI_TEMPLATE.yaml 生成OpenAPI规范 → 使用 MARKDOWN_TEMPLATE.md 生成可读文档 ``` --- ## 📋 支持的框架 | 语言/平台 | 框架 | 路由标识 | |----------|------|---------| | **Python** | FastAPI, Flask, Django | `@app.route`, `@router.get`, `path()` | | **Node.js** | Express, NestJS | `app.get()`, `@Get()`, `router.post()` | | **Dart/Flutter** | Shelf, Serverpod | `Router()`, `@Route()` | | **其他** | 任何RESTful API | 标准HTTP方法定义 | --- ## 🔄 执行流程 ### 步骤1: 发现API端点 使用 **Grep** 工具搜索路由定义： ```bash # 搜索路由装饰器和定义 grep -r "@route\|@app\|@api\|@Get\|@Post\|@Put\|@Delete" --include="*.py" --include="*.js" --include="*.dart" ``` 使用 **Glob** 工具定位API文件： ```bash # 查找常见的API文件 glob "**/*api*.py" glob "**/*routes*.py" glob "**/*controller*.dart" ``` ### 步骤2: 分析API代码 对每个发现的端点，使用 **Read** 工具读取代码并提取： 1. **HTTP方法**: GET, POST, PUT, DELETE, PATCH 2. **路径**: `/api/users/{id}` 3. **路径参数**: `{id}`, `{userId}` 4. **查询参数**: `?page=1&limit=10` 5. **请求体**: JSON schema 6. **响应**: 状态码和响应体schema 7. **认证要求**: Bearer token, API key等 8. **描述和示例** ###