WorkBuddy基于代码语义自动生成OpenAPI 3.0标准API文档：①通过注解驱动（@EnableWorkBuddyDoc、@ApiOperation等）提取接口信息；②支持YAML配置全局元信息；③可注入真实响应示例；④提供/v3/api-docs和/swagger.yaml导出接口。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
WorkBuddy 本身不直接“生成代码模型”，但能基于你提供的代码逻辑，自动生成符合行业标准的 API 接口文档（含路径、参数、响应示例等），并支持导出为 OpenAPI 3.0 格式。整个过程无需手写 Swagger 注解或 YAML，核心是让 WorkBuddy 理解你的代码语义。
启用注解驱动的文档自动提取
这是最常用、最稳定的方式，适用于 Spring Boot 等主流后端框架：
- 在项目中引入 workbuddy-swagger-starter 依赖，版本需与当前 WorkBuddy 核心模块对齐
- 主启动类添加 @EnableWorkBuddyDoc 注解，开启自动装配能力
- 每个 Controller 方法上方加上 @ApiOperation，说明业务意图（如“创建订单”）
- 所有入参标注 @ApiParam，注明是否必填、长度限制、含义（如“用户手机号，11位数字”）
配置全局文档元信息（YAML 方式）
避免把标题、版本、联系人等硬编码进代码，统一用外部配置管理：
WorkBuddy Visio — Visio 兼容架构图生成器
下载
使用 draw.io（.drawio 格式）和 SVG 生成兼容 Microsoft Visio 的架构图。当用户需要以下任一场景时触发： - 用于 Visio 或技术文档的架构/系统/网络图 - 带连接标注的分层控制系统图 - 将 draw.io XML 转换为稳定、可嵌入的 SVG - 修复 Visio 或 draw.io 无法打开的故障排查类图表 - 任何需专业级布局且文本可编辑的图表
- 在 resources/ 下新建 workbuddy-doc.yaml
- 写入关键字段：title（服务名）、version（如 v2.4.0）、contact.name（负责人）、license.name（协议）
- 在 application.properties 中指定路径：workbuddy.doc.config-location=classpath:workbuddy-doc.yaml
- 重启服务后，访问 /wb-doc 即可看到带品牌信息的 HTML 文档页
注入真实响应示例值
默认生成的响应体常是空对象，不利于前端联调。WorkBuddy 支持动态注入样例：
- 新建一个类（如 UserLoginSuccessExample），实现 IExampleProvider 接口
- 在 @ApiResponse 中引用该类，指定状态码（如 code = "200"）
- 返回值会是真实格式的 JSON 示例，包含 token、user_id、expire_time 等字段
导出标准 OpenAPI 文件供协作
生成的文档不仅可在线浏览，还能导出为团队或第三方对接所需的机器可读格式：
- 访问 /wb-doc/v3/api-docs 可获取原始 OpenAPI 3.0 JSON
- 访问 /wb-doc/swagger.yaml 直接下载 YAML 文件
- 配合工具（如 Postman、Apifox、Swagger UI）导入后，即可生成测试请求、Mock 服务、SDK 代码
