用途:从项目代码中自动提取 API 信息,识别路由、划分模块并生成结构化 API 文档;也支持前端组件文档和 Next.js/Nuxt.js API 路由文档。触发场景包括用户要求生成 API 文档、分析项目 API、编写接口文档等。
主要能力:代码扫描、路由识别、模块划分、文档结构化与内容填充。标准流程为三步:先用 scripts/api_scanner.py 扫描项目,参数含 --project-dir(必需)、--framework(默认 auto)、--output;再用 scripts/module_classifier.py 分析结构,参数含 --input、--output;最后用 scripts/doc_generator.py 生成文档,参数含 --input、--output-dir(默认 api/)。生成 api/ 目录,包含 overview.md、authentication.md、base-info.md、endpoints/、error-handling.md、rate-limiting.md、changelog.md、support.md。
使用方式:仅使用 Python 标准库(ast、re、json、pathlib 等),无需额外安装依赖;输出目录在生成时自动创建。支持框架见 description,可显式指定 --framework 提高识别准确率。
限制:脚本使用正则表达式和 AST 解析识别路由,复杂动态路由可能无法完全识别,需手动补充;参数提取依赖代码注释和类型注解;模块划分基于路径第一段,特殊结构需手动调整;生成后建议人工审核并补充业务说明与示例;资料说明脚本提供基本框架和逻辑,完整实现需根据具体需求进一步开发。