@ApiImplicitParams是Swagger的注解。

这个注解用在控制器的方法上，用于说明方法的一组请求参数。

我们看一下这个注解的实际应用：

@ApiOperation(value = "分页获取标签列表")
@ApiImplicitParams({
      @ApiImplicitParam(
        name="pageNo",
        value="请求页数",
        required = false,
        dataType="Integer",
        paramType="query"
      ),
      @ApiImplicitParam(name="pageSize",value="请求页大小",required = false,dataType="Integer",paramType="query"),
      ...
})
@GetMapping("/tags")
public List<Tag> tags() {
	...
}

我们看到@ApiImplicitParams注解是和@ApiImplicitParam注解配合使用的。

@ApiImplicitParams注解描述的是一组请求参数，而单个请求参数是由@ApiImplicitParam注解来描述的。

下面来介绍一下@ApiImplicitParam中各个参数的含义

• name：参数名

• value：参数解释

• required：参数是否必须

• dataType：参数类型

• paramType：参数放在哪个地方，有以下取值

  • header：请求头
  • query：?param=value的形式
  • path：路径，Restful风格接口
  • body：请求体
  • form：以form表单的形式提交

参考文章

swagger2 注解说明 ( @ApiImplicitParams )

Swagger-Core Annotations