Spring集成Swagger常见错误及解决办法

合集下载
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

Spring集成Swagger常见错误及解决办法
⽬录
概览
问题⼀
原因
解决办法
问题⼆
原因
解决办法
概览
在当下⼏乎所有的公司都采⽤了前后端分离的开发模式,Swagger作为了在API在线⽂档⼯具,⼏乎是后端开发的必备组件,最近公司的有个项⽬,在项⽬启动和打开Swagger页⾯时候,后端产⽣了⼤量的异常⽇志,虽然不影响现在的正常启动,不过,每次看到⼤量的异常⽇志,对于有代码洁癖的我,不能忍。

于是乎今天抽了个时间把以下这些问题解决了,解决后再看⽇志,简直不能再爽歪歪啦~ 下⾯对问题以及解决的办法做个记录。

问题⼀
异常描述:No enum constant org.springframework.web.bind.annotation.RequestMethod.Get
项⽬启动的时候,后台⽇志报如下异常:
原因
根据异常栈,能看出是springfox-swagger-common执⾏OperationHttpMethodReader.apply()⽅法是抛出来的,分析⽇志RequestMethod.Get 没有对应的enum,通过检查Controller中RequestMethod,发现了问题所在:
枚举类中method⽅法都是⼤写,⽽我的代码中将method写成了:
导致了在获取enum类型的时候,匹配不上抛出异常。

解决办法
将httpMethod = "Get" 给成 "GET"即可。

其实原来就很好奇为什么httpMethod后添加的⽅法名称是⼤写,当时也没有深⼊的去研究,正好借此机会知道背后的原因,这样在开发过程中才能避免很多坑~~
问题⼆
异常描述:ng.NumberFormatException:For input string:""
项⽬起来后,访问swagger-ui.html页⾯后,接⼝⽂档可以正常展⽰和使⽤,不过后台会出现异常的⽇志:
原因
看⽇志,swagger-models这个包中的AbstractSerializableParameter.getExample()⽅法的时候出现异常了,此外还有⼀条WARN⽇志,Illegal DefaultValue null for parameter type integer,意思是:有个默认值是空字符串的变量转换成Integer类型时异常。

通过全局检索:Illegal DefaultValue,查看如下:
发现example只判断的null这种情况,当example如果为空字符串的话,照样往下执⾏,Long.valueOf(example)就是抛出异常,奔溃的⼼,好想把他的源码改掉呀~
解决办法
分析了下maven的包依赖:
发现swagger-models的版本为 1.5.20,果断去mvnrepository上去寻找有么有新的包修复过这个bug:
发现最新的版本 1.6.2,果断换成最新版本:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- 解决 Illegal DefaultValue null for parameter type integer -->
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>1.6.2</version>
</dependency>
看下源码:
发现这个bug已经修复啦,哈哈哈哈
以上就是Spring集成Swagger常见错误及解决办法的详细内容,更多关于Spring集成Swagger常见错误的资料请关注其它相关⽂章!。

相关文档
最新文档