spring boot Swagger2(version=2.7.0) 注解@ApiImplicitParam的属性dataType值为”自定义泛型“应用

最新推荐文章于 2025-10-18 08:30:00 发布

原创最新推荐文章于 2025-10-18 08:30:00 发布 · 2.7w 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#swagger2 #spring boot #@ApiImplicitParam #dataType #自定义泛型

工具专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍了如何使用 Swagger 的 @ApiImplicitParams 和 @ApiImplicitParam 注解来为 API 输入参数进行注解，特别是针对自定义泛型类的 dataType 属性的正确设置方式。通过示例展示了如何设置必要的参数属性，如 name、value、paramType、dataType 和 required，并提供了实际的代码示例。

注解：

@ApiImplicitParams

@ApiImplicitParam

name="需注解的API输入参数"，

value="接收参数的意义描述"，

paramType="参数存放位置"，

dataType="参数类型，可传基本类型、类、泛型类等"，

required="输入参数是否必传"

其它属性暂时忽略，具体可查看官网等资源。

敲重点：属性“dataType”基本类型、类按照正常来赋值，自定义泛型类应该按照如下格式来赋值：

例如：dataType = "demo«ArrayList«demo1»»"，重点是符号“«»”。

以下摘自swagger2源码（各位看官请自行体会）：

fieldName	typeName	qualifiedTypeName
genericByteArray	GenericType«Array«byte»»	springfox.documentation.schema.GenericType<byte[]>
genericCategoryArray	GenericType«Array«Category»»	springfox.documentation.schema.GenericType<springfox.documentation.schema.Category[]>

示例：
@ApiImplicitParams(value = {@ApiImplicitParam(name = "input", value = "接收参数的意义描述", paramType = "body", dataType = "demo«ArrayList«demo1»»", required = true), @ApiImplicitParam(name = "index", value = "接收参数的意义描述", paramType = "query", dataType = "String", required = true)})

效果图：