案例90：API接口文档自动生成

适用场景

项目API接口缺少文档，需要从代码自动生成接口文档。

操作步骤

1. 打开WorkBuddy，新建对话，切换至Craft模式
2. 选择工作空间目录为项目代码文件夹
3. 输入API文档生成指令
4. AI自动扫描Controller/路由文件
5. 提取每个接口：路径、方法、参数、返回值、描述
6. 按标准格式生成API文档（Swagger/Markdown格式）
7. 输出API文档Markdown文件

指令模板

从这个Spring Boot项目的Controller类自动生成API接口文档：1.扫描所有@Controller/@RestController类；2.提取每个接口：请求路径、HTTP方法、请求参数（名称/类型/必填/描述）、返回值结构、接口描述；3.按Swagger Markdown格式输出；4.按模块分组（用户模块/订单模块/商品模块）；5.标注已废弃接口；6.输出API文档Markdown文件。

涉及 Skills / 专家 / 连接器

代码分析能力、文档生成Skill、后端开发专家

注意事项与技巧

• 代码中的注释越完整，文档描述越准确
• 生成后建议人工补充业务背景说明
• 可定期自动更新文档保持与代码同步

效率提升

1天→30分钟