Api接口文档

一、@API 

使用在类上，表明是swagger资源，@API拥有两个属性：value、tags；

生成的api 文档会根据tags分类，直白的说就是这个controller中的所有接口生成的接口文档都会在tags这个list下；tags如果有多个值，会生成多个list，每个list都显示所有接口

@Api(tags = "列表1")
@Api(tags = {"列表1","列表2"})

value的值类似tags，但不能有多个

二、@ApiOperation

使用于方法上，表示一个http请求的操作

1.@ApiOperation注解不是Spring自带的，它是swagger里的
2.@ApiOperation注解是用来构建Api文档的
3.@ApiOperation（value = “接口说明”,httpMethod = "接口请求方式",response = "接口返回参数；类型",notes = "接口发布说明"）

三、@ApiParam

使用在方法上或者参数上，字段说明；表示对参数的添加元数据（说明或是否必填等）
name–参数名
value–参数说明
required–是否必填

四、@ApiModel()
使用在类上，表示对类进行说明，用于参数用实体类接收
value–表示对象名
description–描述

五、@ApiModelProperty()
使用在方法，字段上，表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

六、@ApiImplicitParam
作用在方法上，用于设置单个请求参数
name：参数名
value：参数的具体意义，作用
required：参数是否必填
dataType：参数的数据类型
paramType：查询参数类型，有以下几种形式：  （与SpringMVC中的@RequestBody冲突，可以用@ApiParam）

        path 以地址的形式提交数据
        query 直接跟参数完成自动映射赋值
        body 以流的形式提交 仅支持POST
        herader 参数在request headers 里边提交
        form 以form表单的形式提交 仅支持POST