需上传spring boot项目源码并配置workbuddy-ai-doc-plugin依赖，ai自动提取@restcontroller接口生成openapi 3.0 yaml；依赖@apioperation等注解补全说明，git元数据或手动指定版本信息，最终导出可交互html及pdf文档。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要为新上线的后端服务快速产出可交付、可协作、带示例的技术文档，但手动整理接口路径、参数说明、响应结构耗时且容易遗漏关键字段。
上传源码并触发AI解析
1、将项目根目录（含src/main/java或src/等标准结构）完整拖入WorkBuddy对话框，或输入绝对路径如D:\Projects\PaymentService。
2、输入指令：请基于该Java Spring Boot项目，提取所有@RestController类中定义的HTTP接口，识别请求方法、路径、查询参数、请求体结构及成功响应格式，生成OpenAPI 3.0兼容的YAML文档。
3、系统自动排除test/、resources/、.git/等非源码目录，仅扫描编译路径下的真实业务代码。若项目未配置spring-boot-maven-plugin，则无法识别运行时依赖，【必须确保pom.xml中已声明workbuddy-ai-doc-plugin依赖】。
注入Git元数据补全上下文
方法一：自动读取本地Git仓库信息
确认项目已初始化Git仓库，并完成至少一次commit；在指令末尾追加：“同步读取Git元数据，将最新tag作为版本号填入文档标题，origin URL填入‘源码地址’字段，最近3条commit摘要整合为‘更新日志’。”
方法二：手动指定元数据
若项目尚未接入Git，可直接提供三行信息：版本号（如v1.4.2）、源码地址（如https://git.example.com/payment-service）、更新日期（2026-07-26）。WorkBuddy会将其写入YAML的info节，但不会校验URL有效性。
绑定代码注释生成接口说明
第一步：检查注释覆盖率
腾讯云代码助手CodeBuddy旗下WorkBuddy 4.24.8版本正式发布。本版本重点修复了上下文压缩异常、冷加载时偶现历史消息丢失、任务停止卡死等问题，并深度优化了Windows沙箱(lightSandbox)的日志写入与误弹窗逻辑，提供更安全稳定的AI协作体验。
执行mvn compile后，WorkBuddy会扫描每个@PostMapping方法上方的@ApiOperation和@ApiParam注解；若某接口无@ApiOperation，则该接口在生成文档中仅显示路径与方法，不出现描述、参数详情或示例。
第二步：补全缺失注释
对未标注的接口，立即在方法上方添加@ApiOperation(value = "创建支付订单", notes = "接收用户ID与商品SKU，返回订单号与跳转链接")；参数级需用@ApiParam(required = true, value = "用户唯一标识，长度32位UUID")明确约束，否则AI无法推断是否必填或格式要求。
第三步：验证注释生效
重新触发文档生成任务，打开输出的openapi.yaml，搜索对应path项，确认summary、description、required字段均已填充，且example值来自真实注释而非空对象占位符。
导出并校验最终文档
1、生成完成后，点击「导出为HTML」按钮，系统调用内置Swagger UI渲染器生成可交互页面。
2、在浏览器中打开该HTML，逐个点击接口展开，检查“Try it out”功能是否可用——若按钮灰显，说明consumes或produces字段缺失，需回源码补全@RequestMapping(produces = "application/json")。
3、右键另存为PDF，保存至docs/api-reference.pdf，该文件已内嵌所有截图、响应示例与跳转锚点，无需二次排版。
