解决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 相关文章推荐
手把手教你用SpringBoot将文件打包成zip存放或导出
Jun 11 Java/Android
JPA如何使用entityManager执行SQL并指定返回类型
Jun 15 Java/Android
浅析NIO系列之TCP
Jun 15 Java/Android
Java如何实现树的同构?
Jun 22 Java/Android
Spring Boot两种全局配置和两种注解的操作方法
Jun 29 Java/Android
Java移除无效括号的方法实现
Aug 07 Java/Android
Java面试题冲刺第十九天--数据库(4)
Aug 07 Java/Android
Java 实现限流器处理Rest接口请求详解流程
Nov 02 Java/Android
Java中的随机数Random
Mar 17 Java/Android
JAVA 线程池(池化技术)的实现原理
Apr 28 Java/Android
Jmerte 分布式压测及分布式压测配置
Apr 30 Java/Android
Java Spring Lifecycle的使用
May 06 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写的serv-u的web申请账号的程序
2006/10/09 PHP
基于linnux+phantomjs实现生成图片格式的网页快照
2015/04/15 PHP
Thinkphp关闭缓存的方法
2015/06/26 PHP
用Div仿showModalDialog模式菜单的效果的代码
2007/03/05 Javascript
javascript 读取图片文件的大小
2009/06/25 Javascript
js实现网页右上角滑出会自动消失大幅广告的方法
2015/02/27 Javascript
JavaScript你不知道的一些数组方法
2017/08/18 Javascript
vue实现手机号码抽奖上下滚动动画示例
2017/10/18 Javascript
详解webpack-dev-server使用http-proxy解决跨域问题
2018/01/13 Javascript
小程序兼容安卓和IOS数据处理问题及坑
2018/09/18 Javascript
Javascript中parseInt的正确使用方式
2018/10/17 Javascript
js中事件对象和事件委托的介绍
2019/01/21 Javascript
小程序关于请求同步的总结
2019/05/05 Javascript
Python中模拟enum枚举类型的5种方法分享
2014/11/22 Python
Python实现扣除个人税后的工资计算器示例
2018/03/26 Python
Django实现登录随机验证码的示例代码
2018/06/20 Python
python查看模块,对象的函数方法
2018/10/16 Python
Django时区详解
2019/07/24 Python
python实现的自动发送消息功能详解
2019/08/15 Python
关于Flask项目无法使用公网IP访问的解决方式
2019/11/19 Python
详解Pycharm与anaconda安装配置指南
2020/08/25 Python
一文带你了解Python 四种常见基础爬虫方法介绍
2020/12/04 Python
HTML5拖拽API经典实例详解
2018/04/20 HTML / CSS
行政管理人员精品工作推荐信
2013/11/04 职场文书
高分子材料与工程专业个人求职信
2013/12/15 职场文书
学生会主席事迹材料
2014/01/28 职场文书
英语专业职业生涯规划范文
2014/03/05 职场文书
小学生节约用水倡议书
2014/05/15 职场文书
机电一体化应届生求职信
2014/08/09 职场文书
党员教师个人对照检查材料范文
2014/09/25 职场文书
2015届大学生就业推荐表自我评价
2014/09/27 职场文书
普通党员个人整改措施
2014/10/27 职场文书
2014年结对帮扶工作总结
2014/12/17 职场文书
保证书格式
2015/01/16 职场文书
医院见习总结
2015/06/24 职场文书
MySQL中distinct和count(*)的使用方法比较
2021/05/26 MySQL