Swagger注解

在Controller代码中使用swagger提供的注解，暴露Api。

类注解

@Api

说明该类的做用

• tags 标签，用于逻辑分组，若是不使用，生成的文档会使用方法名
• protocols 使用的协议
• description 描述

@ApiIgnore

隐藏Api

方法注解

@ApiOperation

说明方法的做用

• value 方法概要，120字符之内
• notes 方法详述
• consumes content格式，如"application/json, application/xml"，"- multipart/form-data"（用于Swagger文件上传）

@ApiImplicitParams / @ApiImplicitParam

说明单个参数

• name 参数名
• value 参数的意思
• required 参数是否必须传
• dataType 参数数据类型（类类型）
• paramType 参数类型，能够为path，query，body，header，form

@ApiImplicitParams({
            @ApiImplicitParam(value = "id", name = "user_id", dataType = "Integer", paramType = "path"),
            @ApiImplicitParam(value = "字段", name = "fields", dataType = "String", paramType = "query", required = true)
    })

@ApiResponses / @ApiResponse

后者只能用在前者中，若是是通用的返回码，应该注解类

• code 返回码
• message 说明
• response 返回实体