Idea 配置Live Templet 自动生成swagger注释模板

最新推荐文章于 2025-06-28 09:04:36 发布

乔帆

最新推荐文章于 2025-06-28 09:04:36 发布

阅读量3.1k

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/weixin_40596063/article/details/90897864

本文介绍了如何在IntelliJ IDEA（Idea）中配置Live Template来自动生成Swagger注释，以提高工作效率并确保接口文档与代码同步。通过设置Live Template，用户可以快速创建带有Swagger注解的方法注释，避免手动编写带来的不便。文章还提供了手动配置步骤，并鼓励读者分享优化建议。

公司项目考虑使用swagger的注释方式。简单看了一下，使用swagger生成文档要在方法上添加额外的注解来支持swagger文档生成。大概是这个样子

    /**
     * @author: qiaofan
     * @date: 2019/6/4 18:07
     * @version: 1.0
    */
    @ApiOperation("")//一句话描述该方法
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id",value = "填写入参说明",required = false,dataType = "数据类型",paramType = "入参来源" ),
            @ApiImplicitParam(name = "page",value = "填写入参说明",required = false,dataType = "数据类型",paramType = "入参来源" ),
            @ApiImplicitParam(name = "pagesize",value = "填写入参说明",required = false,dataType = "数据类型",paramType = "入参来源" ),
            @ApiImplicitParam(name = "id1",value = "填写入参说明",required = false,dataType = "数据类型",paramType = "入参来源" ),
            @ApiImplicitParam(name = "page1",value = "填写入参说明",required = false,dataType = "数据类型",paramType = "入参来源" ),
            @ApiImplicitParam(name = "pagesize1",value = "填写入参说明",required = false,dataType = "数据类型",param