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后添加的方法名称是大写，当时也没有深入的去研究，正好借此机会知道背后的原因，这样在开发过程中才能避免很多坑~~

问题二

异常描述：java.lang.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常见错误的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • Spring Boot整合Mybatis Plus和Swagger2的教程详解

    Spring Boot整合Mybatis Plus和Swagger2的教程详解

    前言:如果你是初学者,请完全按照我的教程以及代码来搭建(文末会附上完整的项目代码包,你可以直接下载我提供的完整项目代码包然后自行体验!),为了照顾初学者所以贴图比较多,请耐心跟着教程来,希望这个项目Demo能给你一些帮助,如果觉得写的还可以请给个关注和点赞,谢谢! 题外话:这是我第一篇用markdown来写的博文,格式不好的地方请见谅 一.pom.xml和application.yml 1.pom.xml中添加相关依赖,这里我把我的pom.xml代码贴出来 <?xml version="1

  • springboot如何集成Swagger2

    springboot如何集成Swagger2

    一.是什么 当下很多公司都采取前后端分离的开发模式,前端和后端的工作由不同的工程师完成.在这种开发模式下,维持一份及时更新且完整的 Rest API 文档将会极大的提高我们的工作效率.传统意义上的文档都是后端开发人员手动编写的,相信大家也都知道这种方式很难保证文档的及时性,这种文档久而久之也就会失去其参考意义,反而还会加大我们的沟通成本.而 Swagger 给我们提供了一个全新的维护 API 文档的方式. 二.为什么要使用它 1.代码变更,文档跟着代码变.只需要少量的注解Swagger就可以根据

  • 手把手教你SpringBoot快速集成Swagger的配置过程

    手把手教你SpringBoot快速集成Swagger的配置过程

    导语 相信大家无论是做前端还是做后端的,都被接口接口文档所折磨过,前端抱怨接口文档和后端给的不一致,后端抱怨写接口文档很麻烦,所以Swagger就诞生了.直接配置即可自动生成接口文档,而且提供了高效的API测试 话不多说直接开干 导入SpringBoot集成Swagger所需要的依赖 <!--web方便测试--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId&g

  • 关于springboot集成swagger及knife4j的增强问题

    关于springboot集成swagger及knife4j的增强问题

    参考链接:狂神的Swagger笔记 号称世界上最流行的API框架 Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新 直接运行,在线测试API 支持多种语言 (如:Java,PHP等) 官网:swagger SpringBoot集成Swagger 添加maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2&

  • springboot+swagger2.10.5+mybatis-plus 入门详解

    springboot+swagger2.10.5+mybatis-plus 入门详解

    最新idea2020安装部署超详细教程 懂得懂的 2020.3 2020.2.4 2020.2.3 2020.2.2 20.2.1 2019.3 2018.3 最新2020永久 springboot简介: 个人对springboot的一点小的理解: 1.最大优势:简化配置 区别于传统的 MVC 模式,对于配置进行了大量的简化,魔鬼注解:SpringBootApplication 中包含了的注解 @SpringBootConfiguration @EnableAutoConfiguration @

  • SpringBoot整合Swagger2的步骤详解

    SpringBoot整合Swagger2的步骤详解

    简介 swagger是一个流行的API开发框架,这个框架以"开放API声明"(OpenAPI Specification,OAS)为基础, 对整个API的开发周期都提供了相应的解决方案,是一个非常庞大的项目(包括设计.编码和测试,几乎支持所有语言). springfox大致原理: springfox的大致原理就是,在项目启动的过种中,spring上下文在初始化的过程, 框架自动跟据配置加载一些swagger相关的bean到当前的上下文中,并自动扫描系统中可能需要生成api文档那些类,

  • SpringBoot 开发提速神器 Lombok+MybatisPlus+SwaggerUI

    SpringBoot 开发提速神器 Lombok+MybatisPlus+SwaggerUI

    导读 Lombok:可以让你的POJO代码特别简洁,不止简单在BO/VO/DTO/DO等大量使用,还有设计模式,对象对比等 MybatisPlus:增加版Mybatis,基础的数据库CRUD.分页等可以直接生成使用,避免了大量的重复低效代码,还有数据库自动Java类,sql文件等等,比传统的更贱简介易用 SwaggerUI:接口文档自动生成,对接前端和测试更加方便,基于业界的OpennApi规范,采用Swagger3.x版本. 技术栈 SpringBoot2.4+ MybatisPlus+Lom

  • 关于springboot整合swagger问题及解决方法

    关于springboot整合swagger问题及解决方法

    一.前言 解决了一个困扰很久的问题.自己搭建的一个springboot项目,整合完jsp之后可以正常访问前端界面,但当再整合上swagger之后,前端界面就无法访问了.当注释掉swagger之后,前端界面又可以正常访问. 二.整合jsp 1.pom引入 <!-- 添加jsp引用 --> <dependency> <groupId>org.apache.tomcat.embed</groupId> <artifactId>tomcat-embed-

  • springboot使用swagger-ui 2.10.5 有关版本更新带来的问题小结

    springboot使用swagger-ui 2.10.5 有关版本更新带来的问题小结

    问题1 常见问题 1.需要传入后台的为string类型 但是使用swagger-ui 接口进行测试的时候,输入的为数字类型,建议对pom.xml文件进行调整 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>${swagger.version}</version> </de

  • SpringBoot集成Swagger2构建在线API文档的代码详解

    SpringBoot集成Swagger2构建在线API文档的代码详解

    第一部分:代码集成 pom.xml <!--swagger2配置--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>i

随机推荐