SpringBoot--Swagger2常用的注解

1.Api

@Api是类上注解。控制整个类生成接口信息的内容。
tags：类的名称。可以有多个值，多个值表示多个副本。
description:描述，已过时。

@RestController
@RequestMapping("/people")
@Api(tags = {"mydemo"},description = "描述")
public class DemoController {

在swagger-ui.html中显示效果。

2.ApiOperation

@ApiOperation写在方法上，对方法进行总体描述
value：接口描述
notes：提示信息

@ApiOperation(value="接口描述",notes = "接口提示信息")

在swagger-ui中显示效果

3.ApiParam

@ApiParam写在方法参数前面。用于对参数进行描述或说明是否为必添项等说明。
name：参数名称
value：参数描述
required：是否是必须

public People getPeople(Integer id, @ApiParam(value="姓名",required = true) String name, String address)

4.ApiModel

@ApiModel是类上注解，主要应用Model，也就是说这个注解一般都是写在实体类上。
value：名称
description：描述

@ApiModel(value = "人类",description = "描述")
public class People {

5.ApiModelProperty

@ApiModelProperty可以用在方法或属性上。用于当对象作为参数时定义这个字段的内容。
value：描述
name：重写属性名
required：是否是必须的
example：示例内容
hidden：是否隐藏。

@ApiModelProperty(value = "姓名",name = "name",required = true,example = "张三")
private String name;

6.ApiIgnore

@ApiIgnore用于方法或类或参数上，表示这个方法或类被忽略。和之前讲解的自定义注解@NotIncludeSwagger效果类似。只是这个注解是Swagger内置的注解，而@NotIncludeSwagger是我们自定义的注解。

7.ApiImplicitParam

@ApiImplicitParam用在方法上，表示单独的请求参数，总体功能和@ApiParam类似。
name：属性名
value：描述
required：是否是必须的
paramType：属性类型
dataType：数据类型

@PostMapping("/getPeople")
@ApiImplicitParam(name = "address",value = "地址",required = true,paramType = "query",dataType = "string")
public People getPeople(Integer id, @ApiParam(value="姓名",required = true) String name, String address){

如果希望在方法上配置多个参数时，使用@ApiImplicitParams进行配置。示例如下：

@ApiImplicitParams(value={@ApiImplicitParam(name="id",value = "编号",required = true),@ApiImplicitParam(name="name",value = "姓名",required = true)})