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

注解:

@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)})

效果图:

原文地址:https://blog.csdn.net/segmentliuxijun/article/details/81676989

转载于:https://www.cnblogs.com/jpfss/p/11446239.html

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger是一种用于描述、构建和生成RESTful风格的Web服务的工具集。它提供了一种简单且易于理解的方式来定义API的结构、参数、返回值等信息,并且可以生成可交互的API文档。 在Swagger中,`@ApiImplicitParam`是一个用于描述API接口参数的注解。它可以用于指定参数的名称、类型、位置、是否必需等信息。然而,从Swagger 3.0版本开始,`@ApiImplicitParam`已经被废弃,取而代之的是`@Parameter`注解。 `@Parameter`注解与`@ApiImplicitParam`类似,用于描述API接口参数。它可以指定参数的名称、类型、位置、是否必需等信息。与`@ApiImplicitParam`不同的是,`@Parameter`注解提供了更加灵活和可扩展的功能,可以支持更多的参数类型和配置选项。 使用`@Parameter`注解时,你可以通过设置`in`属性来指定参数的位置,例如`in = ParameterIn.PATH`表示参数位于URL路径中,`in = ParameterIn.QUERY`表示参数位于URL查询参数中,`in = ParameterIn.HEADER`表示参数位于请求头中,等等。 此外,你还可以使用`@Parameter`注解的其他属性来指定参数的名称、类型、是否必需等信息。例如,你可以使用`name`属性指定参数的名称,使用`schema`属性指定参数的数据类型,使用`required`属性指定参数是否必需等。 总结一下,`@Parameter`注解Swagger 3.0版本中用于描述API接口参数的注解,它提供了更加灵活和可扩展的功能,可以替代`@ApiImplicitParam`注解

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值