Springboot下swagger-ui.html访问不到的解决方案
作者:牧竹子 发布时间:2022-08-20 20:52:22
Springboot swagger-ui.html访问不到
问题
在前面的Swagger2的基本配置中是可以访问到swagger-ui.html的
但当自定义继承配置WebMvcConfigurationSupport后便无法访问到该页面,原因参考请看参考资料。
首先看我的自定义配置,
*************
* HttpMessageConverter转换处理
* 处理转义hmtl标签为正常的hmtl标签
* @author zjcjava@163.com
*
*/
@Configuration
public class WebConfig extends WebMvcConfigurationSupport {
@Bean
public MappingJackson2HttpMessageConverter customJackson2HttpMessageConverter() {
MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(
DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapper.getSerializerProvider().setNullValueSerializer(
new JsonSerializer<Object>() {
@Override
public void serialize(Object value, JsonGenerator jgen,
SerializerProvider provider) throws IOException,
JsonProcessingException {
jgen.writeString("");
}
});
// 进行HTML解码
objectMapper.registerModule(new SimpleModule().addSerializer(
String.class, new JsonSerializer<String>() {
@Override
public void serialize(String value, JsonGenerator jgen,
SerializerProvider provider) throws IOException,
JsonProcessingException {
jgen.writeString(StringEscapeUtils.unescapeHtml4(value));
}
}));
jsonConverter.setObjectMapper(objectMapper);
return jsonConverter;
}
@Override
public void configureMessageConverters(
List<HttpMessageConverter<?>> converters) {
converters.add(customJackson2HttpMessageConverter());
super.addDefaultHttpMessageConverters(converters);
}
}
如果我把该文件全部注释掉则会正常显示,否则无法访问到swagger-ui.html,
解决方法
如果继承了WebMvcConfigurationSupport,则在配置文件在中配置的相关内容会失效,需要重新指定静态资源
因此参照资料2我做了处理如下,在该代码的末尾加上静态资源配置
代码加在
*************
* HttpMessageConverter转换处理
* 处理转义hmtl标签为正常的hmtl标签
* @author zjcjava@163.com
*
*/
@Configuration
public class WebConfig extends WebMvcConfigurationSupport {
@Bean
public MappingJackson2HttpMessageConverter customJackson2HttpMessageConverter() {
MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(
DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapper.getSerializerProvider().setNullValueSerializer(
new JsonSerializer<Object>() {
@Override
public void serialize(Object value, JsonGenerator jgen,
SerializerProvider provider) throws IOException,
JsonProcessingException {
jgen.writeString("");
}
});
// 进行HTML解码
objectMapper.registerModule(new SimpleModule().addSerializer(
String.class, new JsonSerializer<String>() {
@Override
public void serialize(String value, JsonGenerator jgen,
SerializerProvider provider) throws IOException,
JsonProcessingException {
jgen.writeString(StringEscapeUtils.unescapeHtml4(value));
}
}));
jsonConverter.setObjectMapper(objectMapper);
return jsonConverter;
}
@Override
public void configureMessageConverters(
List<HttpMessageConverter<?>> converters) {
converters.add(customJackson2HttpMessageConverter());
super.addDefaultHttpMessageConverters(converters);
}
/**
* 发现如果继承了WebMvcConfigurationSupport,则在yml中配置的相关内容会失效。 需要重新指定静态资源
*
* @param registry
*/
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations(
"classpath:/static/");
registry.addResourceHandler("swagger-ui.html").addResourceLocations(
"classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations(
"classpath:/META-INF/resources/webjars/");
super.addResourceHandlers(registry);
}
/**
* 配置servlet处理
*/
@Override
public void configureDefaultServletHandling(
DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
}
swagger-ui的坑,swagger-ui.html无显示
且返回200无报错,且/v2/api-docs可以正常访问
因为粗心,踩中的坑,代码规范,细心真的能节省很多时间
上图,界面显示如图,一切都正常,控制台,也没有报错,很诡异吧
docs却可以正常访问,包括接口,都是正常的,网上很多解决方案都是说,跨域问题,或者是静态资源访问不到
1,首先跨域问题,会报错,有很明显的报错提示,这里排除,
2,静态资源,可以参考csdn上的其他方案很多,排查方法,可以查看targer目录下是否有静态文件
现在说这个问题导致的原因,以及解决方案
由于当时再写 * 相关代码,里面还涉及到过滤器,网上说到swagger会和 * 有冲突,所以一直错误认为是 * 导致的问题,而且还有fastdfs的相关代码,也有说这两个起冲突,没办法,一一排查,进行版本回滚,发现fasdfs这个版本没有问题,这里要说,平时开发一定要切分支,分支切不了也要多提交版本,这样一旦出现问题也好解决。
然后下个版本发现,加上 * ,问题就又出现了,把 * 所有代码注释掉,问题依旧,百思不得其解,无奈,地毯扫描,版本不一样的全部注释,直到注释到controller层,又正常了,非常怀疑,一个controller,service业务代码这些不应该导致出问题的,怎么会是这的问题,然后进入代码准备细查,打开代码惊喜就来了
这是代码,本来还准备去看service层,看下是不是业务上有什么代码报错,到这就感觉更奇怪了,什么代码都没写,去掉就正常了,然后搜一下是不是方法名重复了,发现没有,
这时发现:@RequestMapping(),对就是这个注解,里面没东西是什么鬼,估计是当时注释的时候直接给删掉了,加入值后一切恢复正常
现在想想,swagger本来就是对controller的提取,没有报错就可以怀疑接口问题。
来源:https://blog.csdn.net/zjcjava/article/details/78064264


猜你喜欢
- 问题描述提交表单到servlet时出现空白页面,但又网站不报错截图如下遇到这个问题查找了很多,仍没有解决,刚开始接触IDEA,以为是路径配置
- 1. 继承1. 子类继承了父类,获得父类的全部Field和方法。子类Student类继承父类,将可以获得父类的全部Field和方法publi
- 添加依赖<dependency> <groupId>com.belerweb
- 由于近来学习java,遇到了一些在c++上没有的概念,将它记录下,以自己复习使用,如有不理解妥之处,望大家批评指导。资料均由网上经过自己整合
- 直接插入排序<code class="language-java hljs ">import java.ut
- 前言本文基于itext7实现pdf加水印和合并的操作。实际上在我们实际项目应用中,对于pdf的操作也是比较常见的,我上一个项目中就有将结果转
- C#删除只读文件的方法: if (File.GetAttributes(FFName).ToString().IndexOf("R
- 对于clear与new Map的区别。我们首先来看一个例子,本例子是我在实际开发中遇到的,需求就是讲map放入到list中,说白了就是lis
- 一、File --> new -->project二、构建maven项目。三、创建项目名,报名,项目路径。四、选择好maven仓
- 比如要获取打开摄像头的应用程序名称,只需要在frameworks/base/core/android/hardware/Camera.jav
- 几个月前写过一篇博客《xUtils3.0框架学习笔记》 ,上面也有记录通过xUtils实现文件上传的使用方法,代码如下:private vo
- 目录前言:对文章出现的一些名词进行解释一、插入排序1.基本思想2.直接插入排序3.希尔排序(缩小增量排序)二、选择排序1.基本思想2.直接选
- 在模板文件的表达式中,可以使用“${T(全限定类名).方法名(参数)}”这种格式来调用Java类的静态方法。开发环境:IntelliJ ID
- 简介java中可以被称为Number的有byte,short,int,long,float,double和char,我们在使用这些Nubme
- 这是一篇关于LIstView实现动态数据渲染的文章! 首先我们讲讲数据是如何来规划的 一般情况下我们有两种规划方案前提比如我们数据
- 举个例子:我有如下的一个需求,当我想要取得用户信息的时候,会先从本地缓存中查找,找不到然后从分布式缓存中查找,最后找不到再从数据库中查询。但
- 目录为什么要实现调用链跟踪?如何实现?第一步,看图、看场景,用户浏览器的一次请求行为所走的路径是什么样的第二步,实现。不想看代码可直接拉最后
- 如何在原有日期时间上加几个月或几天在原有的时间上添加几个月SimpleDateFormat df = new SimpleDateForma
- 对于服务器端开发人员而言,调用第三方接口获取数据,将其“代理”转化并返给客户端几乎是家常便
- Pattern类定义public final class Pattern extends Object implementsSerializ