【swagger】@ApiImplicitParam注解Integer类型required=true时不能提交、@ApiImplicitParam注解dataType=“integer“不能传参问题


以下内容基于swagger2.9.2进行讲解

<!--swagger2-->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>

一、问题描述

swagger中用@ApiImplicitParam注解的时候,若dataType=Integer类型且required=true时,在swagger页面中执行方法报红且不能提交。

当为其他类型如String时没有问题

@ApiOperation(value = "测试2")
@ApiImplicitParams(
        @ApiImplicitParam(name = "id",value = "主键id",required = true,dataType = "Integer",paramType = "query")//dataType = "Integer",web页面无法进入请求
)
@GetMapping("/test2")
public void test2(Integer id){
    log.info("id"+id);
}

swagger页面报错如下:
当点击Execute后,报红不能提交
在这里插入图片描述

二、问题原因

猜测是因为dataType需要是私有类型,而不是包装类型。这个在1.5版本中有说明,不过没找到确切证据,有知道的也可以评论一下
https://docs.swagger.io/swagger-core/v1.5.X/apidocs/io/swagger/annotations/ApiImplicitParam.html#dataType()

三、解决方法

3.1、修改dataType=int

修改dataType=int且required=true时可提交通过

@ApiOperation(value = "测试2")
@ApiImplicitParams(
        @ApiImplicitParam(name = "id",value = "主键id",required = true,dataType = "int",paramType = "query")
)
@GetMapping("/test2")
public void test2(Integer id){
    log.info("id"+id);
}

在这里插入图片描述

3.2、修改dataType=Long

修改dataType=Long,且required=true时可提交通过

@ApiOperation(value = "测试2")
@ApiImplicitParams(
        @ApiImplicitParam(name = "id",value = "主键id",required = true,dataType = "Long",paramType = "query")
)
@GetMapping("/test2")
public void test2(Integer id){
    log.info("id"+id);
}

在这里插入图片描述

3.3、修改dataType类型为String类型

  1. 当dataType="String"类型时,required=true是没问题的
  2. 当dataType类型为Integer时,也可以直接删除dataType属性,这样默认就是String类型,此时required=true也是可以提交的
@ApiOperation(value = "测试2")
@ApiImplicitParams(
        @ApiImplicitParam(name = "id",value = "主键id",required = true,dataType = "String",paramType = "query")
)
@GetMapping("/test2")
public void test2(String id){
    log.info("id"+id);
}

在这里插入图片描述

3.4、当dataType类型为Integer时,删除required=true

当dataType类型为Integer时,若required不为true,也可提交通过

@ApiOperation(value = "测试2")
@ApiImplicitParams(
        @ApiImplicitParam(name = "id",value = "主键id"dataType = "Integer",paramType = "query")
)
@GetMapping("/test2")
public void test2(Integer id){
    log.info("id"+id);
}

在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

五月天的尾巴

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值