解决Swagger2返回map复杂结构不能解析的问题


Posted in Java/Android onJuly 02, 2021

今天有同事用swagger2开发时,有一方法返回Map<String,List<Object>>出现无法解析错误。

Pom.xml引入的swagger版本如下:

<!--swagger start-->
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.5.20</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
 
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
        <!--swagger end-->

具体原因:

swaggerconfig没有默认添加map的复杂结构引起的,需要手动添加。

步骤:

1. 找到swaggerconfig类,在Docket方法里添加一些mapRule即可

2. 这里设计rule比较灵活,我就按标题的格式添加,其中Model.class是自定义的业务类,换成自己的即可。

docket.alternateTypeRules(AlternateTypeRules.newMapRule(String.class, List.class));
docket.alternateTypeRules(AlternateTypeRules.newMapRule(List.class, Model.class));

具体代码如下:

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
 
        docket.alternateTypeRules(AlternateTypeRules.newMapRule(String.class, List.class));
        docket.alternateTypeRules(AlternateTypeRules.newMapRule(List.class, Model.class));
        return docket;
    }
}

Swagger使用过程中遇到的坑

1、无限请求

如果swagger页面请求有错误,swagger会无限尝试访问,后面重启项目的时候,控制层会无限刷新出现日志的内容

本地的好办,如果项目项目部署到服务器中,可能十几分钟产生几个G的日志文件

解决方式:最简单的方式——关闭请求报错的浏览器

2、同名问题

@Api(同名的问题) 因为swagger会根据tags 的名称查找对象,有同名对象的时候,swagger的文档就会出现问题

如果swagger的某个API下出现不属于该API的请求,这个就是API的同名的问题,查找相同的API名称替换即可

3、类上的注解“/”的问题

@ApiModel(不能使用“/”)

解决Swagger2返回map复杂结构不能解析的问题

Errors
Hide
Resolver error at paths./v1-0/Configuration/add.post.parameters.1.schema.properties.listHotCarBrandIVO.items.$ref
Could not resolve reference because of: Could not resolve pointer: /definitions/热门车/品牌/的IVO does not exist in document

4、使用map作为返回类型报错,

Errors
Hide
Resolver error at definitions.Map«string,List«卖车车辆信息OVO»».additionalProperties.$ref
Could not resolve reference because of: Could not resolve pointer: /definitions/List does not exist in document

两个解决方案:升级swagger版本号,这个是我用2.8.0报错会报错,网上有说升级版本可以解决,这个我没有去试,

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>

我这边的解决方案是,将map定义在对象中,面向对象编程,而且这样生成文档的时候,注释也会显示好

解决Swagger2返回map复杂结构不能解析的问题

5、swagger版本的问题,2.8之前的版本在 路径/{id} +@pathVarisble 这样的写法

2.8之前,swagger给出的类型居然是body,需要用json的格式传这个很奇怪,

版本更新到2.8以后,路径后面绑定的参数就是 swagger给出的类型居然是就能是param

适当的更新版本有好处

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

6、没有重现过的一个bug

Failed to execute 'fetch' on 'Window': Failed to parse URL from http://localhost/8765undefindFailed to parse URL from http://localhost/8765undefind

我一直重启项目 swagger没有重现问题

后来我修改请求你方法上的api注释,重启就可以,可能是swagger上api冲突,关键是这个没有提示,好晕;如果谁找到重现这个问题来说一下

以上为个人经验,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Java/Android 相关文章推荐
ConstraintValidator类如何实现自定义注解校验前端传参
Jun 18 Java/Android
springboot如何初始化执行sql语句
Jun 22 Java/Android
idea搭建可运行Servlet的Web项目
Jun 26 Java/Android
java设计模式--七大原则详解
Jul 21 Java/Android
java调用Restful接口的三种方法
Aug 23 Java/Android
java中用float时,数字后面加f,这样是为什么你知道吗
Sep 04 Java/Android
SpringBoot中使用Redis作为全局锁示例过程
Mar 24 Java/Android
springboot应用服务启动事件的监听实现
Apr 06 Java/Android
Android自定义双向滑动控件
Apr 19 Java/Android
Java由浅入深通关抽象类与接口(上篇)
Apr 26 Java/Android
带你了解Java中的ForkJoin
Apr 28 Java/Android
Java实现带图形界面的聊天程序
Jun 10 Java/Android
SpringBoot工程下使用OpenFeign的坑及解决
Jul 02 #Java/Android
SpringBoot读取Resource下文件的4种方法
Jul 02 #Java/Android
Java基础-封装和继承
Java 泛型详解(超详细的java泛型方法解析)
SpringBoot集成Druid连接池连接MySQL8.0.11
Java使用httpRequest+Jsoup爬取红蓝球号码
使用Springboot实现健身房管理系统
You might like
PHP生成验证码时“图像因其本身有错无法显示”的解决方法
2013/08/07 PHP
php实现的获取网站备案信息查询代码(360)
2013/09/23 PHP
使用PHP导出Redis数据到另一个Redis中的代码
2014/03/12 PHP
PHP多个文件上传到服务器实例
2014/10/29 PHP
php实现图片上传并利用ImageMagick生成缩略图
2016/03/14 PHP
Thinkphp3.2实用篇之计算型验证码示例
2017/02/09 PHP
详解phpstorm2020最新破解方法
2020/09/17 PHP
JavaScript 在线压缩和格式化收藏
2009/01/16 Javascript
jquery 问答知识整理
2010/02/11 Javascript
新发现一个骗链接的方法(js读取cookies)
2012/01/11 Javascript
jquery聚焦文本框与扩展文本框聚焦方法
2012/10/12 Javascript
正则表达式搭配js轻松处理json文本方便而老古
2013/02/17 Javascript
通过JS动态创建一个html DOM元素并显示
2014/10/15 Javascript
z-blog SyntaxHighlighter 长代码无法换行解决办法(jquery)
2014/11/16 Javascript
Bootstrap每天必学之滚动监听
2016/03/16 Javascript
JavaScript 函数的执行过程
2016/05/09 Javascript
JavaScript实现鼠标点击导航栏变色特效
2017/02/08 Javascript
简单谈谈CommonsChunkPlugin抽取公共模块
2017/12/31 Javascript
解决vuejs项目里css引用背景图片不能显示的问题
2018/09/13 Javascript
Koa 使用小技巧(小结)
2018/10/22 Javascript
实例讲解Python中的私有属性
2014/08/21 Python
Python验证码识别处理实例
2015/12/28 Python
python交互式图形编程实例(二)
2017/11/17 Python
python递归实现快速排序
2018/08/18 Python
python交互模式下输入换行/输入多行命令的方法
2019/07/02 Python
python数据预处理方式 :数据降维
2020/02/24 Python
详解HTML5 data-* 自定义属性
2018/01/24 HTML / CSS
英国网上花店:Bunches
2016/11/29 全球购物
Ariat官网:美国马靴和服装品牌
2019/12/16 全球购物
电工实训报告总结
2014/11/05 职场文书
2015年度村委会工作总结
2015/04/29 职场文书
2016年暑期见闻作文
2015/11/25 职场文书
爱岗敬业事迹材料
2019/06/20 职场文书
Python 多线程处理任务实例
2021/11/07 Python
Win11如何修改dns?Win11修改dns图文教程
2022/01/18 数码科技
OpenStack虚拟机快照和增量备份实现方法
2022/04/04 Servers