用途:自动梳理并记录服务器 API 表面,生成标准化 API 文档,支持 Markdown 或 Swagger/OpenAPI 格式。
主要能力:扫描源码定位服务入口(如 server.js、app.py),追踪路由定义(Express .get()、Flask @app.route、FastAPI 装饰器),识别 Body、Query Params、Path Variables 等输入;生成或更新 API_DOCUMENTATION.md,或输出 OpenAPI/Swagger 规范。文档结构涵盖端点详情(METHOD /path、描述、限流、鉴权要求)、请求规范(路径/查询参数、请求头、精确 body schema 及类型与校验规则)、响应规范(200 成功含完整 JSON 示例,并记录所有可能错误码如 400、401、409 及其消息格式与排查提示)、代码示例(cURL 及 JavaScript/Python 片段)、使用指南(入门、分页、过滤与排序)。
使用方式:提供源码目录或入口点,指定输出格式;技能使用 grep_search 查找路由定义,使用 view_file 理解请求/响应 schema,随后按工作流分析与生成文档。
适用场景:需要为后端服务快速产出或更新 API 文档、统一接口说明、补充错误码与示例时。
限制:资料未提供具体安装命令、收费、平台支持或效果保证;实际识别范围取决于源码结构与所用框架,需确保每个已识别路由均被列出。