应启用clawbot插件自动注入注解、配合swagger-core注解处理器静态生成openapi文档、再通过clawbot webhook对接swagger2word导出word文档,实现java项目swagger文档的一键输出。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您正在使用ClawBot工具为Java项目生成Swagger文档注解,但尚未实现接口文档的一键输出,则可能是由于注解未正确注入或文档生成链路未打通。以下是解决此问题的步骤:
一、启用ClawBot IDEA插件自动注入注解
ClawBot作为IDEA插件,可基于POJO字段的JavaDoc或类型信息,批量生成标准Swagger 2.0/3.0注解,避免手动逐行编写。该方法适用于Controller、DTO、VO等类的快速标注。
1、在IntelliJ IDEA中打开Settings → Plugins,搜索并安装ClawBot插件(或从JetBrains Marketplace下载Bitkylin Universal Generate,其ClawBot模块已集成同类能力)。
2、重启IDEA后,右键点击目标Java类文件,在弹出菜单中选择ClawBot → Generate Swagger Annotations。
3、在弹窗中勾选需生成的注解类型:@ApiModel、@ApiModelProperty、@ApiOperation、@ApiParam,确认执行。
4、插件将自动扫描字段JavaDoc(如存在),提取描述并转换为@ApiModelProperty(value = "用户姓名", example = "张三")格式;若无JavaDoc,则依据字段名与类型生成默认描述。
二、配合Swagger-Core注解处理器静态生成
该方式不依赖运行时环境,通过编译期注解处理(APT)直接从源码提取结构,生成符合OpenAPI 3.0规范的JSON/YAML文档,适合CI/CD流水线集成。
1、在pom.xml中添加swagger-core和swagger-annotations依赖:
2、在Spring Boot主类或配置类上添加@OpenAPIDefinition和@Info注解,声明全局文档元信息。
3、在src/main/resources下创建openapi-generator-config.yaml,指定输出路径、包名及模板。
4、执行Maven命令:mvn compile io.swagger.core.v3:swagger-maven-plugin:generate,自动生成openapi.json至指定目录。
三、通过ClawBot WebHook对接Swagger2Word导出Word文档
当Swagger规范已生成(如openapi.json),ClawBot支持将其推送至Swagger2Word服务,触发自动化Word排版与导出,实现“注解→JSON→Word”端到端闭环。
1、启动本地Swagger2Word服务:java -jar swagger2word.jar --server.port=8081。
2、在ClawBot插件设置中配置WebHook地址:http://localhost:8081/api/convert,请求方法设为POST。
3、在IDEA中完成注解生成后,右键选择ClawBot → Export to Swagger2Word。
4、插件自动读取当前模块的openapi.json,封装为multipart/form-data请求发送至Swagger2Word。
5、Swagger2Word接收后立即渲染并返回API_Document_20260523.docx下载链接,含自动生成目录、接口表格、请求示例与响应结构。











