Swagger常用注解

1.@Api：位置：类上方  属性：tags，对整个类的描述   description：具体描述

@Api(tags = {"MyDemo"},description = "描述")//这个注解在类上方，作用在接口文档里面，对整个类的描述，在界面中的具体的接口上方

2.@ApiOperation：位置：方法上方  属性：(value = "对接口的描述",notes = "接口的提示信息")//这个接口在方法上面，作用在接口文档里面，对接口的描述

@ApiOperation(value = "对接口的描述",notes = "接口的提示信息")//这个接口在方法上面，作用在接口文档里面，对接口的描述

3.@ApiParam：位置：参数前面，用于对参数进行描述或说明是否为必添项等说明  参数：name：参数名称   value：参数描述   required：是否为必须 

public People people(Long id,@ApiParam(value = "这是一个姓名",required = true) String name){

4.@ApiModel：位置：在类上方，主要作用在接口文档中的Model里面，也就是说这个注解一般是写在实体类上  属性：value：名称    description：描述

 

5.@ApiModelProperty注解： 位置：实体类的属性上方，一般用于方法、属性的说明          属性：value：字段说明   name：重写属性名   required：是否必须   example：示例内容   hidden：是否隐藏

6.@Apiignore注解：位置：用于方法或类或参数上，表示这个方法或类被忽略，和之前的自定义注解一效果类似，只是这个注解是swagger的内置注解 

7.@ApiImplicitParam注解：用在方法上，表示单独的请求参数，作用和ApiParam类似

属性：value：对接口中的参数进行简单的描述    name：描述接口中参数的名称    required：是否为必须   paramType ：接口中的参数应该用在哪个地方，常用的位置有：header、query、path

dataType：接口中参数的类型

想在@ApiImplicitParam中设置多个参数时，可以使用@ApiImplicitParams（@ApiImplicitParam（），@ApiImplicitParam（））