SpringBoot3+Springdoc:v3api-docs可以访问,html无法访问的解决方法

项目环境

springboot 3.3.4

pom.xml引用如下(springdoc相关的只有这一个,理论上说,要跑springdoc或者叫它swagger3,除了springboot,加这个就可以了,不需要任何配置类配置、application.properties/yaml配置!!)

(当然,你跑通了之后需要自定义配置了再配)

复制代码
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.6.0</version>
</dependency>

问题描述

启动服务器之后:

v3/api-docs可以访问,并返回json数据。

/swagger-ui/index.html无法访问,报错404。

解决方法

spring配置类里配一下swagger-ui的资源路径,然后访问/swagger-ui/index.html就好了。

PS:路径里最后的5.17.14建议查一下自己引用的依赖是什么版本。

复制代码
@SpringBootApplication
public class SpringbootApplication implements WebMvcConfigurer {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 配置 Swagger UI 资源路径
        registry.addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/swagger-ui/5.17.14/");
    }
}

解决过程

  1. 先改日志级别 logging.level.root=debug
  2. 启动访问swagger-ui.html(这里被误导了,应该去swagger-ui/index.html,不过对排查没影响,排查后也明白过来了)
  3. 回去看服务器debug日志,发现在查找资源的时候,找的那些路径似乎没有swagger相关的资源路径,然后想起来之前查的哪个文里提到了swagger-ui.jar里的资源地址,然后顺着摸过去
  4. 欸,里面有个index.html,我觉得就是它了,然后印象里有另一个文里说了资源路径的配置方法,照着配一下资源路径,ojbk

展示

访问(我配的端口是18080):localhost:18080/swagger-ui/index.html

上方的搜索栏输入api-docs的网址,点击Explore即可。

相关推荐
Setsuna_F_Seiei5 小时前
前端转型 Agent 开发 06 之 Agent Memory 记忆系统(让 Agent 更智能,更懂你)
前端·agent·ai编程
zhangzeyuaaa6 小时前
Ruby 多线程、GVL(GIL)与 Mutex 完全指南
开发语言·前端·ruby
默_笙6 小时前
🌊 向量库和 ES 都查不出"关系",我只好给奶茶建了一张人脉网
前端·javascript
优选资讯6 小时前
标签打印软件怎么对接 Excel 数据
前端·excel
一个风轻云淡7 小时前
GCC 和 GDB命令简单解读
java·linux·前端
u0111026758 小时前
图片处理接口如何统一错误信息 前端提示与后端错误码设计
前端·状态模式
福兮说9 小时前
浏览器里把 iPhone 的 HEIC 转成 JPG:Chrome 解不开、转完大了七成、拍摄时间全丢,六个坑实测
前端·javascript·图像处理·chrome·ios·iphone·heic
libokaifa9 小时前
把语音模型塞进手机:sherpa-onnx 在 Android 上的 ASR / TTS
前端
deli0079 小时前
DLA 枝晶生长实测:5000 个粒子集体停摆之后,分形维数收敛到 1.70
前端
IT_陈寒9 小时前
Redis卡顿的锅,这次真不是大key的错
前端·人工智能·后端