WorkBuddy中可通过四步实现Swagger注解自动生成功能:一、配置Live Templates快速生成带注解的Controller;二、集成SmartDoc插件无注解抽取API文档;三、使用Javadoc驱动APT编译期注入注解;四、联动内置HTTP Client实时渲染Swagger UI。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在WorkBuddy中开发Spring Boot项目,但手动编写Swagger注解耗时且易遗漏,则可能是由于缺乏标准化的代码生成机制。以下是实现API自动归档与Swagger注解快速生成的具体操作路径:
一、启用Lombok + Swagger3注解组合模板
通过预定义Lombok与Swagger3兼容的代码模板,可在生成实体类或Controller方法时自动注入@Api、@ApiOperation等注解,避免逐行手写。
1、在WorkBuddy的Settings → Editor → Live Templates中,点击“+”号新建Template Group,命名为“SwaggerAuto”。
2、在该组下新增Live Template,Abbreviation设为“swagctrl”,Description填写“自动生成带Swagger注解的Controller方法”。
3、Template text中粘贴以下内容:
@RestController
@RequestMapping("$PATH$")
@Api(tags = "$TAG$", description = "$DESC$")
public class $CLASS$ {
@GetMapping("$ENDPOINT$")
@ApiOperation(value = "$METHOD_DESC$", notes = "$NOTES$")
public ResponseEntity $METHOD_NAME$() {
return ResponseEntity.ok().build();
}
}
4、在Edit variables对话框中,为$TAG$、$DESC$、$PATH$等变量设置Expression为“clipboard()”,允许粘贴上下文值快速填充。
5、勾选“Reformat according to style”和“Shorten FQ names”,应用后即可在Java类中输入“swagctrl”并按Tab键触发生成。
二、集成SmartDoc插件实现无注解文档抽取
SmartDoc无需在源码中添加任何Swagger注解,仅依赖标准JavaDoc与接口签名结构,即可生成符合OpenAPI 3.0规范的JSON与HTML文档,并同步输出至WorkBuddy内置文档面板。
1、在WorkBuddy中打开File → Project Structure → Project Settings → Modules → Dependencies,点击“+”添加Maven依赖:com.power.doc:power-doc:2.7.5。
2、在src/main/resources目录下创建smart-doc.json,配置scanPath为“com.example.controller”,setArchivePath为“docs/api”。
3、右键项目根目录,选择“SmartDoc → Generate API Documentation”,执行后自动生成docs/api目录下的html与openapi.json文件。
4、在WorkBuddy右侧Tool Window中打开“SmartDoc Viewer”,点击刷新按钮,即可实时加载最新API树形结构与参数表格。
使用 draw.io(.drawio 格式)和 SVG 生成兼容 Microsoft Visio 的架构图。当用户需要以下任一场景时触发: - 用于 Visio 或技术文档的架构/系统/网络图 - 带连接标注的分层控制系统图 - 将 draw.io XML 转换为稳定、可嵌入的 SVG - 修复 Visio 或 draw.io 无法打开的故障排查类图表 - 任何需专业级布局且文本可编辑的图表
三、使用Javadoc驱动的Annotation Processor自动注入
通过自定义APT(Annotation Processing Tool)处理器,在编译期扫描带有特定Javadoc标签的方法,动态生成对应Swagger注解字节码,不侵入源码逻辑。
1、新建module命名为“swagger-apt-processor”,引入javax.annotation.processing与org.springframework.web.bind.annotation依赖。
2、创建Processor类继承AbstractProcessor,在process方法中遍历ElementKind.METHOD,检查其DocComment是否包含“@api.summary”或“@api.param”。
3、对匹配方法调用Filer.createSourceFile生成代理类,其中显式添加@Operation、@Parameter等Springdoc注解。
4、在主项目pom.xml中配置
5、执行Build → Build Project后,WorkBuddy会在target/generated-sources/annotations下输出带完整Swagger注解的Controller代理类。
四、配置WorkBuddy内置HTTP Client联动Swagger UI
利用WorkBuddy自带的HTTP Client功能,结合Swagger JSON元数据,实现接口调试与文档查看一体化,跳过浏览器切换步骤。
1、确保项目已启动并暴露/swagger-ui/index.html端点,访问该地址复制页面中Network标签下任意一个swagger.json请求的完整URL。
2、在WorkBuddy中打开Tools → HTTP Client → Open HTTP Console,粘贴该URL到首行,格式为GET http://localhost:8080/v3/api-docs。
3、执行请求后,在响应体右上角点击“View as Swagger”,WorkBuddy自动解析JSON并渲染交互式文档界面。
4、在渲染后的接口卡片中点击“Send Request”,请求将直接发往本地服务,响应结果与原始HTTP Client窗口联动显示。
















