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

更新时间：2021年07月02日 15:18:29 作者：washingtin

这篇文章主要介绍了解决Swagger2返回map复杂结构不能解析的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

今天有同事用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(不能使用“/”)

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定义在对象中，面向对象编程，而且这样生成文档的时候，注释也会显示好

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冲突，关键是这个没有提示，好晕；如果谁找到重现这个问题来说一下

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Maven的配置文件pom.xml详解(含常用plugin)
pom.xml是Maven项目的核心配置文件,它是项目对象模型 - Project Object Model（POM）的缩写,本文我们将全面解析pom.xml,了解其结构和属性,以及如何使用它来管理项目,感兴趣的朋友跟随小编一起看看吧
2024-08-08
AsyncHttpClient的ConnectionSemaphore方法源码流程解读
这篇文章主要为大家介绍了AsyncHttpClient的ConnectionSemaphore方法源码流程解读，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-12-12
将项目上传到Maven中央仓库(2023最新版)
本文主要介绍了将项目上传到Maven中央仓库(2023最新版)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-05-05
java的异常与处理机制分析【附面试题】
这篇文章主要介绍了java的异常与处理机制,结合实例形式分析了Java异常与处理机制的概念、原理、相关操作技巧与注意事项,并附带面试题分析供大家参考,需要的朋友可以参考下
2019-05-05
Java设计模式之桥接模式的示例详解
桥梁模式是对象的结构模式。又称为柄体(Handle and Body)模式或接口(Interface)模式。本文将通过示例来详细讲解一下这个模式，感兴趣的可以学习一下
2022-02-02
Java 精炼解读时间复杂度与空间复杂度
对于一个算法,其时间复杂度和空间复杂度往往是相互影响的,当追求一个较好的时间复杂度时,可能会使空间复杂度的性能变差,即可能导致占用较多的存储空间,这篇文章主要给大家介绍了关于Java时间复杂度、空间复杂度的相关资料,需要的朋友可以参考下
2022-03-03
MyBatis批量插入大量数据(1w以上)
MyBatis进行批量插入数时，一次性插入超过一千条的时候MyBatis开始报错，本文主要介绍了MyBatis批量插入大量数据的解决方法，感兴趣的可以了解一下
2022-01-01
Java中的对象和引用详解
这篇文章主要介绍了Java中的对象和引用详解的相关资料,需要的朋友可以参考下
2017-05-05
如何解决Java多线程死锁问题
死锁是一个很严重的、必须要引起重视的问题，本文主要介绍了死锁的定义，解决方法和面试会遇到的问题，感兴趣的可以了解一下
2021-05-05
Java Grpc实例创建负载均衡详解
这篇文章主要介绍了Java Grpc实例创建负载均衡详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-03-03