swagger注解

　　从官网看出，它是一个规范和完整的框架（如编辑器 Swagger Editor ，显示组件 Swagger Editor ，代码生成 Swagger Codegen ），用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。API管理工具， 更好的管理接口文档，提高写接口文档效率，使得接口文档直观简洁。

 

 

swagger常用注解（主要分为两类，一类是对Model的注解；另一类是对API的注解）

 1.  @API 用在类上，说明该类的作用

    tags    API分组标签。具有相同标签的API将会被归并在一组内展示

    value     如果tags没有定义，value将作为Api的tags使用

   description    API的详细描述

 

 

   2. @ApiOperation    用在方法上，说明方法的作用

            value    对操作的简单说明

            notes    对操作的详细说明

            response    返回的对象

 

   3. @ApiImplicitParams    注解ApiImplicitParam的容器类，以数组方式存储

 

   4.@ApiImplicitParam    对API的单一参数进行注解

            name    参数名称

            value    参数的简短描述

            required    是否为必传参数

            dataType    参数类型，可以为类名，也可以为基本类型（String，int、boolean等）

            paramType    参数的传入（请求）类型，可选的值有path, query, body, header or form

 

    5.@ApiParam    增加对参数的元信息说明

            required    是否为必传参数

            value    参数简短说明

 

    6.@ApiResponses    注解@ApiResponse的包装类，数组结构

 

   7. @ApiResponse    描述一个操作可能的返回结果

            code

            message

            response    返回类型信息，必须使用完全限定类名

            responseContainer    如果返回类型为容器类型，可以设置相应的值

 

    8.@ApiModel：描述一个Model的信息

            value    model的别名，默认为类名

            description    model的详细描述

 

    9.@ApiModelProperty：描述一个model的属性

            value      属性简短描述

            example    属性的示例值

            required    是否为必须值

 

参考： https://www.jianshu.com/p/b0b19368e4a8