API文档与接口规范生成器
扫描后端路由源码,自动提取请求参数与数据结构,生成标准的Markdown或OpenAPI规范文档。
功能与用途
该工具专门用于从后端源码中快速提取 API 接口信息。它支持 Express、FastAPI、Spring Boot、Gin 等多种主流框架,能自动解析 HTTP 请求方法、路由路径、参数要求、认证方式及数据模型,批量导出清晰的 Markdown 接口文档或标准的 OpenAPI 3.0 (Swagger) 规范文件,大幅减少手动维护接口文档的工作量。
适用场景
- 老旧项目补齐接口文档:扫描缺乏文档的现有路由目录,一键生成完整的 Markdown 接口清单与详细说明。
- 导出 OpenAPI 规范规范:从源码路由定义中提取元数据,生成符合 OpenAPI 3.0 标准的 YAML 规范文件。
- 单接口快速说明整理:提供一段路由与控制器代码,自动整理出包含参数、返回体和认证要求的标准化文档。
适用人群
- 后端开发工程师
- 全栈开发者
- API 架构师
- 技术文档工程师
使用步骤
- 指定需要解析的源码文件、路由目录或单个路由代码段
- 选择输出格式为 Markdown 文档或 OpenAPI 3.0 规范
- 运行自动化检测或让 AI 解析提取 HTTP 方法、路径与参数
- 检查生成的文档或 YAML 规范并保存到项目中
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-09-30
- 文件数
- 4
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.