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

相关推荐
_oP_i3 分钟前
Chrome浏览器自动下载的AI模型文件
前端·chrome
小小前端--可笑可笑4 分钟前
【Three.js + MediaPipe】视频粒子特效:实时运动检测与人物分割技术详解
开发语言·前端·javascript·音视频·粒子特效
奔跑的web.5 分钟前
JavaScript 对象属性遍历Object.entries Object.keys:6 种常用方法详解与对比
开发语言·前端·javascript·vue.js
OEC小胖胖10 分钟前
09|DOM Renderer 的 Host 层:从 Fiber 到真实 DOM 的落地
前端·前端框架·react·开源库
xuyuan199810 分钟前
超越Selenium:自动化测试框架Cypress在现代前端测试中的卓越实践(windows版本)三
前端·windows·测试工具·系统架构·cypress
企业对冲系统官13 分钟前
价格风险管理平台审批角色配置与权限矩阵设计
大数据·运维·开发语言·前端·网络·数据库·矩阵
步步为营DotNet14 分钟前
深度剖析.NET 中CancellationToken:精准控制异步操作的关键
java·前端·.net
thinkQuadratic15 分钟前
CSS给文本添加背景颜色等效果
前端·css
波波鱼દ ᵕ̈ ૩16 分钟前
AJAX(1)
前端·javascript·ajax
毕设十刻17 分钟前
基于Vue的酒店管理系统4yv4w(程序 + 源码 + 数据库 + 调试部署 + 开发环境配置),配套论文文档字数达万字以上,文末可获取,系统界面展示置于文末
前端·数据库·vue.js