Swagger常用注解用法

Swagger常用注解含义

@Api:
用于Controller的类上，表示对该类的说明。标识该类是swagger资源，会在swagger界面显示该类的请求
参数
tags:描述类的作用。相当于这个类的一个标题，原本显示是类名，tags内容会覆盖这个类名。
value:描述类的作。会被tags覆盖，没啥用。
description:描述。对该类的一个扩展说明
hidden:默认为false,配置true将在文档中隐藏

@ApiOperation
用于Controller中的方法，表示一个http请求访问该方法的操作，会在文档中显示该接口。
参数
value:对该请求的说明，让人知道该方法的用途。
notes:详细说明，类似备注一样的东西，具体的注意事项，不需要的时候可以不写
tags:对该请求的说明，会覆盖value中的内容。

@ApiModel
表示对类进行描述，主要用于实体类。用实体类接收参数，或用实体类响应。
参数
value:类名
description：描述实体类的作用

@ApiModelProperty
用于实体类中的属性上，说明属性的含义。
参数
value: 描述变量的含义
name: 变量名
requeire: 是否必填 true/false

@ApiIgnore
忽略某个属性，使之不显示在swagger文档中显示

@ApiImplicitParam
一般用于Controller中请求的方法上，对请求参数进行描述
name=“参数名”
value=“参数说明”
dataType=“数据类型”
defaultValue=“参数的默认值”
required=“true” 表示参数是否必须传

@ApiImplicitParams
多个参数时使用，包含多个@ApiImplicitParam，用集合表示，各个元素间用逗号隔开
如
@ApiImplicitParams({
@ApiImplicitParam(name=“mobile”,value=“手机号”,required=true,paramType=“form”),
@ApiImplicitParam(name=“password”,value=“密码”,required=true,paramType=“form”),
@ApiImplicitParam(name=“age”,value=“年龄”,required=true,paramType=“form”,dataType=“Integer”)
})

@ApiParam()
用于方法，参数，字段说明 表示对参数的要求和说明
name=“参数名称”
value=“参数的简要说明”
这个我一般都用来描述@RequestBody注解的对象，其他单独的参数我都用@ApiImplicitParam