内容简介:这几天换了新的设备用于开发。启动项目后访问swagger地址,发现空空如也。本篇文章就来记录下Spring Boot Swagger-UI 404的可能原因及解决方案。若要顺利阅读本篇文章, 需要你具备如下条件:阿航的项目环境:
这几天换了新的设备用于开发。启动项目后访问swagger地址,发现空空如也。本篇文章就来记录下Spring Boot Swagger-UI 404的可能原因及解决方案。
先决条件
若要顺利阅读本篇文章, 需要你具备如下条件:
- 掌握 Java 开发
- 掌握SpringBoot框架
- 掌握Swagger框架及相应配置
阿航的项目环境:
| 环境 | 版本 |
|---|---|
| JDK | 14 |
| SpringBoot | 2.1.13.RELEASE |
| Swagger | 2.9.2 |
一定要注意环境的差异, 考虑不兼容的可能性; 并且具备以上条件. 否则阅读本篇博客可能会给你带来困扰.
问题原因
在网上翻了个遍,众说纷纭。记录下我找到的情况以及对应的解决方案。
情况一:检查Swagger是否限制环境
很明显我们在生产环境不太希望将完整的接口文档暴露出来,我们通常会通过 @Profile
进行限制,比如:
@EnableSwagger2
@Configuration
@Profile("dev")
class SwaggerConfig {
...
上面的 @Profile
的值就是限制了我们仅在哪些环境中展示Swagger。
所以,
检查你的环境是否在 @Profile
内部。
情况二:绑定静态资源文件
在你的Swagger配置文件中(或任何注入Bean的类中)添加:
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
// 解决静态资源无法访问
registry.addResourceHandler("/**")
.addResourceLocations("classpath:/static/");
// 解决swagger无法访问
registry.addResourceHandler("/swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
// 解决swagger的js文件无法访问
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
此方法存在争议,因为新版本的SpringBoot和Swagger并不需要该配置。
以上所述就是小编给大家介绍的《Spring Boot Swagger-UI 404》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
产品经理的20堂必修课
徐建极 / 人民邮电出版社 / 2013-9-1 / 59.00元
《产品经理的20堂必修课》以作者八年的产品经理工作实践为基础,通过系统的理论结合丰富的实例的方法,全面地总结了作为一名互联网产品经理所应掌握的知识。 《产品经理的20堂必修课》分为三大部分。 讲产品:深入剖析互联网产品成功的要素,分别从需求导向、简单原则、产品运营、战略布局等维度,分析如何让产品在残酷的互联网竞争中脱颖而出。 讲方法:着重分析优秀的产品团队运作的工作方法和程序,详......一起来看看 《产品经理的20堂必修课》 这本书的介绍吧!