用途:在代码变更时自动保持文档同步,适用于新增、修改或删除 API 端点,函数或类发生显著变化,架构调整,新增功能或引入破坏性变更等场景。
主要能力:一是检测代码变更,监控 backend/routers//*.py 的 API 端点变化、backend/utils//.py 的函数与类变化以及架构文件的结构变化,并用 git diff 识别改动;二是生成 API 参考,从 FastAPI 路由提取端点信息,解析 @router.get、@router.post 等路由装饰器、函数 docstring、类型提示中的请求/响应模型以及查询参数、路径参数和请求体,生成带示例的 MDX 文档,并更新 .cursor/API_REFERENCE.md、docs/api-reference/endpoint/.mdx、docs/doc/developer/api/*.mdx;三是更新架构图,分析代码结构生成 Mermaid 图,更新 .cursor/ARCHITECTURE.md、.cursor/DATA_FLOW.md 及组件文档;四是同步文档,保持 .cursor/ 内部文档与 docs/ 外部文档一致,更新交叉引用和链接并校验结构。
使用方式:工作流为检测变更、识别影响、生成更新、校验、同步。可通过 /auto-docs、/update-api-docs、/docs 命令触发,也可在提交时通过 Git Hooks 或在 CI/CD 流水线中运行。实现上使用 Python AST 解析路由文件,借助 Pydantic 提取模型 schema,利用 FastAPI 的 OpenAPI 能力,并生成 MDX 文件。
限制:资料未提供具体安装命令、收费、价格、平台支持范围及实际效果数据,暂未提供。