用途:从项目代码自动提取 API 信息,生成结构化 API 文档,触发场景包括“生成 API 文档”“分析项目 API”“编写接口文档”。仅使用 Python 标准库,无需额外安装依赖。
主要能力:调用 scripts/api_scanner.py 扫描项目识别路由与参数,调用 scripts/module_classifier.py 按路径划分模块与层级,再依据 references/doc-structure.md 与 assets/templates/ 模板生成 api/ 目录下的概述、认证、基础信息、端点详情、错误处理、速率限制、变更日志、支持与反馈等章节。
使用方式:步骤1 python scripts/api_scanner.py --project-dir <目录> --framework auto|flask|fastapi|express --output api_scan_result.json;步骤2 python scripts/module_classifier.py --input api_scan_result.json --output api_modules.json;步骤3 创建 api/ 目录并按规范建框架;步骤4 按模块填充端点文档。指定框架可提高识别准确率,FastAPI 可利用类型注解。
适用场景:Flask、FastAPI、Express 项目需要快速产出标准 API 文档时。
限制:脚本用正则与 AST 识别路由,复杂动态路由可能无法完全识别;参数提取依赖注释与类型注解;模块划分基于路径第一段,特殊结构需手动调整;生成后建议人工审核补充业务说明与示例。缺失的价格、收费、平台等事实暂未提供。