使用springdoc-openapi-ui时自定义openapi.json无法在Swagger UI加载问题
问题解决方法
问题根因
你配置的springdoc.swagger-ui.url=openapi.json属于相对路径,Swagger UI页面本身的访问路径前缀是/swagger-ui/,浏览器会自动将相对路径与当前页面路径拼接,最终请求地址变为/swagger-ui/openapi.json,和你实际的静态资源路径不匹配。
解决方案
方案一(推荐):使用根路径匹配
直接修改配置文件中的springdoc.swagger-ui.url属性,路径前加斜杠/声明为站点根路径:
springdoc.swagger-ui.url=/openapi.json
加斜杠后浏览器会直接从服务根路径发起请求,准确命中resources/static目录下的openapi.json文件,无需修改文件存放位置。如果你的项目配置了server.servlet.context-path,只需要把路径补全为/[上下文路径]/openapi.json即可。
方案二:适配相对路径的文件存放
如果要保留原来的相对路径配置,需要把openapi.json文件放在resources/static/swagger-ui/目录下,注意:
- 配置保留
springdoc.swagger-ui.url=openapi.json不变 - 重启项目后清空浏览器缓存再访问,此时Swagger UI发起的
/swagger-ui/openapi.json请求可以正确命中目录下的配置文件。
补充说明
springdoc.api-docs.path属性仅作用于springdoc自动扫描代码生成的OpenAPI文档路径,自定义静态JSON文件的场景下该配置不生效,不需要调整该参数。
内容的提问来源于stack exchange,提问作者Александр Селютин
相关产品推荐
相关产品推荐

