swagger-ui访问不到(swagger2访问)

swagger-ui访问不到(swagger2访问)阅读本文前请先确定访问 swagger ui 的路径是否正确 本文描述的 404 错误与访问路径无关 Swagger 2 http localhost 8080 swagger ui html Swagger 3 OpenAPI 3 0 http localhost 8080 swagger ui index html 我在 Spring Boot 中使用 Springdoc 整合

大家好,我是讯享网,很高兴认识大家。



阅读本文前请先确定访问 swagger-ui 的路径是否正确,本文描述的 404 错误与访问路径无关。

  • Swagger 2:http://localhost:8080/swagger-ui.html
  • Swagger 3(OpenAPI 3.0):http://localhost:8080/swagger-ui/index.html

我在 Spring Boot 中使用 Springdoc 整合 OpenAPI 3.0 生成 API 文档时,访问 Swagger UI 报 404,而其他的配置均正确,访问地址为 http://localhost:8085/swagger-ui.html 。

但是在请求 http://localhost:8085/v3/api-docs/swagger-config 及 http://localhost:8085/v3/api-docs 却是成功返回数据的。

访问swagger-ui.html报404
讯享网

(提示:访问 /swagger-ui.html 会跳转 /swagger-ui/index.html,这是 Springdoc 做的内部重定向,这没问题。)

后来在 Github 上找到和我一模一样的问题:404 not found on swagger UI。

有人说 IDEA 没有加载 依赖,但是我在 IDEA 中能看到 依赖。

看到有人提示覆盖 WebMvcConfigurationSupport 中的 Swagger UI 配置:

 

讯享网

我试了试,居然能成功访问到 Swagger UI。

通过查看在 404 not found on swagger UI 的讨论,我开始找错误原因, issues 中有提到 ,于是我开始找项目中是不是用到 ,发现我在处理跨域时新增了一个配置,配置类继承了 :

讯享网

看到这里大概明白问题所在了,尝试把这个配置删掉,重新启动项目,访问 Swaggger UI,成功访问。

这个配置应该是导致没有加载 swagger-ui 资源的问题所在,所以报 404。

通过查看 springdoc-openapi-ui- {version} .jar 代码发现,springdoc-openapi-ui 提供了 的 方法来添加 swagger-ui 的资源,但是 方法并没有被调用,也就没有加载 swagger-ui 映射。

swagger-ui资源加载代码

但是 springdoc-openapi-ui 是自动配置 swagger-ui 的,到这里怎么会失效了呢? 原来,在我的配置类 中继承了 ,而继承 后,Spring Boot 的自动配置就会失效,需要你自己去配置。因此 方法没有被执行。

因此,加上以下这段代码后能访问到 Swagger UI 就不难理解了。

 

但是,这样使用之后,如果项目中还有其他的配置都需要我们手动配置,这很麻烦,也不推荐。推荐实现 接口来添加配置,看以下的方法一。

使用实现 接口来替代 ,不用再添加其他配置,springdoc-openapi-ui 会自动装配 swagger-ui 的配置。

讯享网

推荐使用这种方式。

继续使用继承 接口的配置,手动添加 swagger-ui 的资源映射配置:

 

其中的 swagger-ui 映射路径中 的 swagger-ui 版本号可在 IDEA 的 Maven 面板中查看 springdoc-openapi-ui 的依赖:

swagger-ui版本

  1. 404 not found on swagger UI

小讯
上一篇 2025-05-21 15:37
下一篇 2025-04-14 17:34

相关推荐

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/157931.html