Swagger 文档常用注解

引用自 https://blog.csdn.net/SIMBA1949/article/details/80926126

　　

## 常用注解及属性

@Api：用在请求的类上，表示对类的说明

• tags="说明该类的作用，可以在UI界面上看到的注解，如果tags多个值，会生成多个list"

• value="该参数没什么意义，在UI界面上也看不到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用

• value="说明方法的用途、作用"

• notes="方法的备注说明"

@ApiParam：单个参数描述

• name：参数名

• value：参数说明

• require d：是否必填

@ApiModel：用对象来接收参数

• value：表示对象名

• description：对对象的描述

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

• value：字段说明

• name：重写属性名

• dataType：重写属性类型

• example：举例说明

• hidden：隐藏

@ApiIgnore：使用该注解忽略这个API，用于类或者方法上

@ApiImplicitParams：用在请求的方法上，表示一组参数说明

@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

• name：参数名

• value：参数的汉字说明、解释

• required：参数是否必须传

• dataType：参数类型，默认String，其它值dataType="Integer"

• defaultValue：参数的默认值

 ## 注解及属性具体表现

@Api：用在请求的类上，表示对类的说明

@RestController
@Api(tags = {"接口集合说明"})
public class SwaggerController

 

 @ApiOperation：用在请求的方法上，说明方法的用途、作用

@ApiOperation(value = "用于方法描述",notes = "用于提示内容")
    @RequestMapping(value = "/hello",method = RequestMethod.GET)

 

 

@ApiParam：单个参数描述

public String hello(@ApiParam(name = "massage",value = "参数说明",required = true)String massage)

 

@ApiModel & @ApiModelProperty