swagger注解及使用说明

用在类上：

@Api()    用在类上，说明类得作用（标识这个类是swagger得资源）

    tags：表说明

    value：表说明可使用tags代替

@ApiIgnore()    用于类、方法、方法参数（表示这个方法或类被忽略）      

用在方法上：

@ApiOperation()    用在方法上，说明方法得作用（表示一个http请求得操作）

    value    用于方法描述

    notes    用于提示内容

    tags    可以重新分组

@ApiImplicitParams    用在方法上，包含一组参数说明，A皮Implicit Param[] value() 包含多个@ApoIimplicitParam

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

    paramType    参数放在那个地方

        header：请求参数得获取@RequestHeader

        query：请求参数得获取@RequestParam

        path(用于restful接口)：请求参数得获取@PathVariable

        body：（不常用）

        form：（不常用）

    name    参数名

    dataType    参数类型

    required    参数是否必填

    value    参数说明

    defaultValue    参数得默认值

@ApiResponses    表示一组响应

@ApiResponse    用在@ApiResponses中用于表达一个错误得响应信息

    code    数字

    message    信息

    response    抛出异常得类

@ApiParam()    用于方法，参数，字段说明，表示对参数的添加元数据（说明是否必填等）

    name    参数名

    value    参数说明

    required    是否必填

实体类：

@ApiModel()    描述一个model得信息，一般用在post创建得时候，使用@RequestBody得场景，请求西安舒无法使用@ApiImplicitParam注解进行描述时(表示对类进行说明，参数用实体类接收)

    value    表示对象名

    description    描述

@ApiModelProperty()    描述对model属性得说明或数据操作的更改

    value    字段说明

    name    重写属性名字

    dataType    重写属性类型

    required    是否必填

    example    举例说明

    hidden    隐藏

  @Authorization    声明要在资源上操作使用的授权方案

  @AuthorizationScope    介绍一个OAuth2授权范围

  @ResponseHeader    响应头设置，使用方法

  @ApiSort    排序

      value    int值