IDEA技巧:如何根据注释生成swagger注解

相信大家在进行java项目开发,肯定会接触到swagger的,一款动态生成api文档的神奇,只需要在api上面加上注解,就可以生成文档,现在我简单介绍下swagger的快速入门,最后再说下如何根据注释快速生成这些烦人的注解。

swagger日常操作

引入swagger依赖

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.9.2</version>

</dependency>



<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.9.2</version>

</dependency>

开启swagger

@Configuration

@EnableSwagger2//开启Swagger2

public class Swagger2Config {

}
 

swagger常用注解

@Api:修饰整个类,描述Controller的作用

@ApiOperation:描述一个类的一个方法,或者说一个接口

@ApiModel:用对象来接收参数 ,修饰类

@ApiModelProperty:用对象接收参数时,描述对象的一个字段

@ApiResponse:HTTP响应其中1个描述

@ApiResponses:HTTP响应整体描述,一般描述错误的响应

@ApiIgnore:使用该注解忽略这个API

@ApiError :发生错误返回的信息

@ApiParam:单个参数描述

@ApiImplicitParam:一个请求参数,用在方法上

@ApiImplicitParams:多个请求参数

 相信大家入门swagger肯定是不难的,但是大家估计都有一个共同的痛点,就是每次开发一个新接口的时候,要加上一堆注解,特别难受,有没有一款插件能够自动生成这些注解呢?

答案是有的。接下来我会给大家介绍下这款插件:Swagger Tools。

直接打开idea的插件仓库:搜索Swagger Tools,就可以直接安装。

 安装之后重启下idea。

如何使用呢?
使用方式很简单,只要在需要生成注解的文件右击,选择gēgenerate->swaggerannotation,就可以直接生成,是不是很简单

 

 

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
要快速基于数据库表生成实体类并自动加上swagger注解,可以采取以下步骤: 1. 首先,需要连接数据库,并读取数据库表的结构信息。可以使用数据库连接工具库如JDBC来连接数据库,使用相关API获取表的元数据信息。 2. 获取表的元数据后,可以通过遍历元数据来生成实体类。可以使用字符串拼接的方式,构建出实体类的代码。 3. 在生成实体类的过程中,需要根据元数据的类型和名称来决定实体类的字段类型和名称。根据元数据的类型,可以将数据库的数据类型转换为对应的Java类型。使用字符串拼接的方式,可以将字段类型、名称及其注解添加到实体类的代码中。 4. 在实体类中加入swagger注解,可以通过在生成实体类代码的过程中,根据表的元数据信息,判断是否应该添加swagger注解。根据元数据的属性,可以判断字段是否为必填项、字段的描述等。根据这些元数据属性,可以通过字符串拼接,将swagger注解的相关信息添加到实体类代码中。 5. 完成实体类的生成之后,可以将生成的实体类保存到指定的路径。可以使用IO操作将生成的代码保存为Java文件。 6. 最后,通过编译器编译生成Java文件,将其转换为字节码文件,并加载到JVM中即可。 通过以上步骤,可以快速基于数据库表生成实体类,并自动加上swagger注解。这样可以方便地生成实体类代码,并为API文档的编写提供便利。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值