Swagger几个常用注解的用途

注解汇总表格:

注解作用使用位置
@Api表示对类的说明常用参数
@ApiOperation说明方法的用途、作用方法
@ApiImplicitParams表示一组参数说明方法
@ApiImplicitParam表示单独的请求参数@ApiImplicitParams中
@ApiModel表示一个返回响应数据的信息响应类
@ApiModelProperty描述响应类的属性属性
@ApiResponses表示一组响应方法
@ApiResponse一般用于表达一个错误的响应信息@ApiResponses中

@Api:用在请求的类上,表示对类的说明常用参数

参数描述
tags说明该类的作用,非空时将覆盖value的值
value描述类的作用
description对api资源的描述,在1.5版本后不再支持
basePath基本路径可以不配置,在1.5版本后不再支持
position如果配置多个Api 想改变显示的顺序位置,在1.5版本后不再支持
produces设置MIME类型列表(output),例:"application/json, application/xml",默认为空
authorizations获取授权列表(安全声明),如果未设置,则返回一个空的授权值
hidden默认为false, 配置为true 将在文档中隐藏

示例代码:

@Api(tags="登录请求")
@Controller
@RequestMapping(value="/highPregnant")
public class LoginController {}

@ApiOperation:用在请求的方法上,说明方法的用途、作用

参数描述
value说明方法的用途、作用
notes方法的备注说明
tags操作标签,非空时将覆盖value的值
response响应类型(即返回对象)
responseContainer声明包装的响应容器(返回对象类型)。有效值为 "List", "Set" or "Map"。
responseReference指定对响应类型的引用。将覆盖任何指定的response()类
httpMethod指定HTTP方法,"GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"
responseHeaders响应头列表
code响应的HTTP状态代码。默认 200
hidden默认为false, 配置为true 将在文档中隐藏

示例代码:

@ResponseBody
@PostMapping(value="/login")
@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public UserModel login(@RequestParam(value = "name", required = false) String account,
@RequestParam(value = "pass", required = false) String password){}

@ApiImplicitParams用在请求的方法上,表示一组参数说明

参数描述
name参数名,参数名称可以覆盖方法参数名称,路径参数必须与方法参数一致
value参数的汉字说明、解释
required参数是否必须传,默认为false [路径参数必填]
paramType参数放在哪个地方
dataType参数类型,默认String,其它值dataType="Integer"
defaultValue参数的默认值

示例代码:

paramType表格位置不够大这里写:
参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
    


@ResponseBody

@PostMapping(value="/login")

@ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")

// ApiImplicitParams里边可以包含多个ApiImplicitParam
@ApiImplicitParams({

@ApiImplicitParam(name = "name", value = "用户名", required = false, paramType = "query", dataType = "String"),

@ApiImplicitParam(name = "pass", value = "密码", required = false, paramType = "query", dataType = "String")

})

public UserModel login(@RequestParam(value = "name", required = false) String account,
@RequestParam(value = "pass", required = false) String password){
    // 方法体
}

@ApiImplicitParam:作用在方法上,表示单独的请求参数 (示例代码看ApiImplicitParams的)

参数描述
name参数名
value参数的具体意义,作用
required参数是否必填
dataType参数的数据类型
paramType查询参数类型,这里有几种形式

@ApiModel:用于响应类上,表示一个返回响应数据的信息

这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)

示例代码:

@ApiModel(value="用户登录信息", description="用于判断用户是否存在")
public class UserModel implements Serializable{
    
private static final long serialVersionUID = 1L;
/**

* 用户名

*/

@ApiModelProperty(value="用户名")

private String account;

/**

* 密码

*/

@ApiModelProperty(value="密码")

private String password;

}

@ApiModelProperty:用在属性上,描述响应类的属性

参数描述
value此属性的简要说明。
name允许覆盖属性名称
allowableValues限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值
access允许从API文档中过滤属性。
notes目前尚未使用。
dataType参数的数据类型。可以是类名或者参数名,会覆盖类的属性名称。
required参数是否必传,默认为false
position允许在类中对属性进行排序。默认为0
hidden允许在Swagger模型定义中隐藏该属性。
example属性的示例。
readOnly将属性设置为只读
reference指定对相应类型定义的引用,覆盖指定的任何参数值

示例代码:

@ApiModel(value="用户登录信息", description="用于判断用户是否存在")
public class UserModel implements Serializable{

private static final long serialVersionUID = 1L;

/**

* 用户名

*/

@ApiModelProperty(value="用户名")

private String account;

/**

* 密码

*/

@ApiModelProperty(value="密码")

private String password;

}

@ApiResponses: 用于表示一组响应

@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息

示例代码:

@ApiResponses({
        @ApiResponse(code=400,message="请求参数没填好"),
        @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
    })

    @RequestMapping(value="/getUser",method=RequestMethod.GET)
    public User getUser(@RequestHeader("username") String username,      @RequestParam("password") String password) {
        return userService.getUser(username,password);
    }

愿你出走半生,归来仍是少年