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即可。

相关推荐
IT_陈寒3 小时前
Vue这个坑我跳了两次,原来问题出在这
前端·人工智能·后端
kyriewen3 小时前
我用 50 行代码重写了 React Router 核心,终于搞懂了前端路由原理
前端·javascript·react.js
WebInfra4 小时前
Rspack 2.1 发布:React Compiler 提速 10 倍!
前端
李明卫杭州4 小时前
CSS 媒体查询详解:一文掌握响应式设计的核心技术
前端
lichenyang4535 小时前
从 H5 按钮到 OpenHarmony 能力调用:我如何理解 ASCF 的运行链路
前端
下家5 小时前
我放弃了 Vue/React,选择自研框架
前端·前端框架
Asize6 小时前
HTML5 Canvas 基础:从按帧动画到 ECharts 数据可视化
前端·javascript·canvas
默_笙6 小时前
🎄 后端给我一堆扁平数据,我 10 行代码把它变成了树
前端·javascript
Mahut6 小时前
我用 Electron + FFmpeg 做了一个本地视频处理工作站 ClipForge
前端·ffmpeg·electron
前端Hardy6 小时前
又一个 AI 神器火了!
前端·javascript·后端