使用了Swagger的@ApiParam会发生无法正常传入参数的问题

最新推荐文章于 2024-08-17 06:00:00 发布
最新推荐文章于 2024-08-17 06:00:00 发布
阅读量2.4k 收藏 2
点赞数 1
分类专栏： JAVA问题解决 奇奇怪怪的问题 文章标签： java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/elapse_/article/details/122888837
版权
在Spring项目中，使用Swagger的@ApiParam注解后，原本能正常传递的参数变为JSON格式导致无法直接传参。解决方案是在参数前添加@RequestParam注解，以确保参数能正确传入。
摘要由CSDN通过智能技术生成

在写一个需要传参验证功能时。

public ResultBean verify(@ApiParam("手机号码")String phoneNumber, @ApiParam("验证码")String userCode)

在没有使用ApiParam参数之前可以正常进行传参功能，但是使用了此注解后发现传参格式会自动变成json格式，然后就无法正常直接输入传参。
会发生以下问题：

最低0.47元/天 解锁文章
elapse_
关注
专栏目录
利用swagger-ui页面发送POST请求参数遇到的中文参数乱码的问题
天问的博客
01-31 8477
前端时间将同事开发的半成品项目接口做成可视化界面，即swagger-ui，用于展示。这个如何配置我就不多说了，网上相关的教程应该也是一搜一大堆......  本地测试了相关接口后，除了几个接口返回: {"resultData":"","serviceTime":1517211417338,"resultStatus":"-1","resultInfo":"无数据或者type和model
swagger注释API详细说明
qq3163566的博客
12-28 2122
常用注解： -@Api()用于类； 表示标识这个类是swagger的资源 -@ApiOperation()用于方法； 表示一个http请求的操作 -@ApiParam()用于方法，参数，字段说明； 表示对参数的添加元数据（说明或是否必填等） -@ApiModel()用于类 表示对类进行说明，用于参数用实体类接收 -@ApiModelProperty()用于方法，字段 表示对model属性的说明或者数据操作更改 -@ApiIgnore()用于类，方法，方法参数 表示这个方法或者类被忽略 -@Ap...
swagger2使用@ApiParam为参数填充注解时无法传输正确的参数到url
代不在‘的博客
11-14 2745
如图，我在控制类中声明一个函数，作用是根据id查找用户信息。在生成swagger文档时，为了让前端更容易理解，需要添加注解，但在添加ApiParam注解后，却出现了输入参数无法正确传到url的报错。 这是不加ApiParam注解的文档。 这是添加ApiParam注解的文档。 解决方法： 在参数列表中，添加@PathVariable注解。 ...
Swagger2注解：让API文档更智能
最新发布
xycxycooo的博客
08-17 583
Swagger是一个用于生成、描述、调用和可视化RESTful Web服务的开放源代码框架。Swagger2是Swagger框架的一个版本，它通过注解的方式，让开发者可以轻松地在代码中定义API文档。通过本文的讲解，我们了解了Swagger2中常用的注解，包括@Api@ApiParam@ApiModel和。这些注解可以帮助我们在代码中直接定义API文档，使得文档与代码保持同步，减少维护成本，提高开发效率。
Swagger2 | 05. 使用Swagger2调试时，部分接口不可传入参数
xyx-Eshang的博客
04-03 2399
1. 发现问题 在使用swagger2生成接口文档时，发现有部分的参数能显示出来，但是在调试的时候，却不能传入参数 2. 尝试 2.1. 不同之处①：提交方式 第一个接口提交方式为GET，第二个接口提交方式为PUT 试着将提交方式换一下 结果成功了。 但与此同时，发现请求类型从原来的body变成了query 2.2. 不同之处②：请求类型 仔细观察，第一个接口（可以传参）的参数请求类型为query 第二个接口（不可传参）的参数请求类型为body 第二个接口请求方式仍然是PUT的情况下，将参数请求类型改
swagger的ApiImplicitParam注解中的required属性不起作用
大尾猴的博客
11-22 619
最终确定到因为在@RequestParam中也有一个required属性，用于指定是否必填。swagger文档在处理时，对于required属性的优先级，@RequestParam注解的优先级高于@ApiImplicitParam。如上两图，在接口中使用了’ApiImplicitParam’注解，仅指定了一个参数是必填，但是通过swagger文档查看三个参数均不能为空。指定一下@RequestParam注解中的required属性为false即可。
swagger2 传参失败（nodeType,nodeName）Response Body返回 no content
林逗哥
12-30 1137
swagger2.7.0 传参失败,我的参数为string类型的nodeType,Response Body返回 no content,Response Code 返回undefined。 两个疑问： 1.swagger下修改nodeType参数名称，如nodeType2,则接口调用正常。 2.同样的接口，参数在postman调用正常。swagger下调用没有反应。 后翻阅各种信息： 参考：Swagger2的try out无反应。对nodeName参数报错_风雨的博客-CSDN博客Swagger2
【swagger】@ApiImplicitParam注解Integer类型required=true时不能提交、@ApiImplicitParam注解dataType=“integer“不能传参问题
weixin_49114503的博客
06-02 1746
【swagger】@ApiImplicitParam注解Integer类型required=true时不能提交、@ApiImplicitParam注解dataType="integer"不能传参问题
springboot使用swagger
qq_43446343的博客
11-01 528
Swagger的介绍 swagger的详细介绍:https://www.jianshu.com/p/349e130e40d5 swagger官网地址:https://swagger.io/%E3%80%82/ Swagger在springboot项目中的使用 swagger,用于根据代码自动生成接口文档,包括请求接口本地测试,相当于普通的接口文档和postman的组合,基于注解实现,在spri...
Java中自定义扩展Swagger的能力，自动通过枚举类生成参数取值含义描述的实现策略
Q54665642ljf的博客
10-05 1143
因为@ApiParam​中指定的内容会被显示到Swagger​界面上，那么在Swagger的框架中，一定有个地方会尝试去获取此注解中指定的相关字段值，然后将注解的内容转为界面上的文档内容。所以想要定制，首先必须要了解当前是如何处理的。先来看下面给定的这个枚举类，其中包含order、value、desc​三个属性值，而value​字段是我们的接口字段需要传入的真实取值，desc​是其对应的含义描述，那么该如何让我们自定义Swagger​扩展类知晓应该使用value和desc字段来生成文档描述内容呢？
swagger最新2.9.2使用，以及重写相关插件修复ApiModel作为query请求参数无法根据postion排序的bug
虎皮青椒没虎皮
02-17 7744
先看一下集成后的完整效果： 依赖 <properties> <springfox-swagger.version>2.9.2</springfox-swagger.version> </properties> <dependency> <groupId>io.springfox</gro...
swigger里面输入参数无法进入方法原因分析
m0_38017835的博客
07-06 776
---BaseException Handler---Host 127.0.0.1 invokes url http://localhost/app/livingCheck ERROR: Required request body is missing: public com.tangdi.production.addon.dto.ResponseDTO com.tangdi.production
@Param传参数，后端拿不到的问题。
Garry
10-24 1616
一、遇到的问题 List<EnvironmentComment> selectEnvironmentCommentList(@Param("environmentComment")EnvironmentComment environmentComment, @Param("startRow")int startRow, @Param("pageSize")int pageSize); ...
使用swagger 2.9.2版本，注解@ApiParam出现的问题
weixin_43665278的博客
12-18 3845
在前后端分离的项目中，为了便捷开发，很多项目中会用到swagger这个工具，其中使用@ApiParam在项目启动后访问swagger页面的时候出现了这样一个问题。 接口层代码： @Api(description = "运动等级体系接口") @Slf4j @RestController @RequestMapping("/SportSystem") public class SportSystemC...
【Swagger 】遇到 “Example values are not available for application/octet-stream media types.“
木头大左的博客
09-01 432
如果您在使用 Swagger 时遇到 "Example values are not available for application/octet-stream media types." 错误，这通常是因为 Swagger 无法为 "application/octet-stream" 类型的响应提供示例值。"application/octet-stream" 是一种通用的二进制流媒体类型，它不包含任何特定的格式或结构信息。因此，Swagger 无法为这种类型提供示例值。
在swagger2如果传递的是对象 页面没有Example Value和Model信息的问题
qq_18973609的博客
12-02 1603
传递对象需要用@ApiImplicitParams包裹@ApiImplicitParam。 如： @ApiImplicitParams( { @ApiImplicitParam(name = "departmentParams", dataType = "DepartmentParams", value = "部门信息", required = true, paramType = "body") } ) 这样就会有model信息！！！
swaggger中请求参数和响应参数显示null的问题处理
handy的博客
11-30 3313
swaggger中请求参数和响应参数显示null的问题处理问题来源问题解决 问题来源 resultful分格接口,入参为对象但是swagger中显示为null 问题解决 @ApiModel(value=“测试”) 这个加在类上的注解 value不能含有特殊符号. 之前为 com.xxxx.xxxx 然后修改掉 . 即可正常显示入参出参 ...
Swagger @Example 与 @ExampleProperty 使用无效原因
wang845252276的专栏
03-30 1273
Swagger UI不支持显示@Example描述
Swagger2.9.2使用@ApiParam遇到的坑
c1085269585的博客
01-19 2636
1.使用@ApiParam产生的问题 public Result delete(@ApiParam("主键id") Integer id){ return adminBiz.delete(id); } 当我按照上面使用@ApiParam的时候Swagger页面是这样显示的 测试的时候根本无法把主键id值传入后台 2.解决方法 添加@RequestParam注解 public Result delete(@ApiParam("主键id") @RequestPara
swagger中@ApiParam与@ApiModel的区别
05-16
在Swagger中，@ApiParam和@ApiModel都是用于API文档的注解，但是它们的作用略有不同。 @ApiParam注解用于描述API接口中的单个参数，可以包含参数名称、描述、数据类型、是否必填等信息。例如： ```java @...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值