Swagger2注解

 

 

注解	域	作用
@Api()	作用于类	使用tags={接口别名}，可以写中文名称
@ApiOperation()	作用于方法上	用于介绍方法
@ApiParam()	作用于方法，参数，字段说明	用于介绍参数
@ApiModel()	作用于类，一般作用于实体类上	用于介绍实体
@ApiModelProperty()	作用于方法，一般作用于实体类得字段上	用于介绍实体字段
@ApiIgnore()	用于类，方法，方法参数	忽略显示某些东西
@ApiImplicitParam()	作用于方法	对隐式参数的解释例如map中包含什么
@ApiImplicitParams()	作用于方法，可包含多个@ApiImplicitParam()	对隐式参数的解释例如map中包含什么

一般我们开发中 使用  @ApiModel()  、@ApiModelProperty()来标识实体以及实体字段，然后通过泛型引用实体，或者返回实体

使用@ApiParam() 注解单个参数，正常不会去使用 @ApiImplicitParam() 注解，当然你的项目参数如果有使用list,或者map就需要使用这个注解