swagger文档无法访问

最新推荐文章于 2025-09-04 16:31:46 发布

原创最新推荐文章于 2025-09-04 16:31:46 发布 · 6k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#spring

文章讨论了在从Swagger2.0升级到3.0时，由于忘记更新路径白名单导致的无法渲染定义的问题。通过将SpringSecurity设置为permitAll并修复路径验证，解决了访问Swagger文档的异常。作者提醒注意在API版本升级后的路径校验以避免类似问题。

1. 报错异常

Unable to render this definition

The provided definition does not specify a valid version field.

Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).

2. 排错过程

将authenticated函数改为permitAll函数，将接口全部开发，则能正常访问swagger文档。

因此，该问题的错误和SpringSecurity有关。

3. 根本原因

之前使用的2.0的swagger，后面更新了3.0的接口，忘了更新路径白名单，导致无法访问。

为什么一直没发现这个问题：是因为为了测试方便，之前一直都没有进行访问路径校验，导致问题没有及时发现。

4. 解决方法：

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

benniaofei18

关注关注

4
点赞
踩
4

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

Fastapi的swagger文档响应超时无法访问的解决办法

什么都干的派森

06-10

357

本文介绍如何解决FastAPI的SwaggerUI因CDN被墙无法访问的问题。首先在main.py开头添加代码，创建/swagger_ui目录并配置静态文件服务，自定义Swagger和Redoc文档路由，使用本地静态资源替代CDN资源。然后在项目根目录下放置下载的Swagger静态文件(可从提供的优快云链接获取)。该方法通过本地化资源成功绕过了CDN访问限制，确保API文档的正常展示。

参与评论您还未登录，请先登录后发表或查看评论

简单记录一下springdoc2.5.0整合springboot3.2.5报错

最新发布

u013622884的博客

09-04

682

摘要：该错误是由于在Spring MVC配置中自定义ObjectMapper并置于消息转换器首位，导致Swagger/OpenAPI文档生成时使用了错误配置。解决方案是通过@Primary注解声明全局ObjectMapper，与SpringDoc的ObjectMapperProvider隔离。这样既保留了自定义序列化规则，又避免影响API文档生成，完美解决冲突问题。（149字）

项目实战系列之swagger在线文档无法访问的一次踩坑记【二】

fei1234456的博客

04-08

3418

目前公司用的swagger在线文档，可是昨天我更新代码后，文档就打不开了，访问的时候后台报错，下面上图：开始也不知道是为什么，以为项目哪个地方有了问题，上厕所的时候，问了一个同事，他那居然可以，由于着急调试接口，就用postman测了一下，今天来上班发现还是不行，然后我就打断点跟了下代码：这里需要用异常断点调试，不然swagger会拦截项目里写了swagger的注解，如图：根据description找到对应的位置：因为在我平时的写法中，没有参数名后面用中括号的，而且这里是Delete请求方

swagger访问不到

while(life)++；

07-12

1560

访问失败的信息解决 SwaggerConfig配置类,主要配置两个东西并使用@EnableSwagger2： createRestApi：扫描的路径。 addResourceHandlers:swagger无法访问，手动指定 apiInfo：swagger的头部信息，不写也可以 @Configuration @EnableSwagger2 public class SwaggerConfig extends WebMvcConfigurationSupport { @Bean publ

Spring Boot 解决跨域Cores问题

岚殿的代码笔记

08-09

1457

import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.CorsRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class CorsConfig implemen.

项目集成swagger，访问不到swagger页面

沉闷萝卜的博客

09-12

4386

springboot+maven+swagger，swagger集成之后，无法访问swagger页面

解决swagger不能访问问题

suk_java的博客

07-05

651

解决swagger不能访问问题

fastapi的swagger文档静态文件

06-10

为此，我们可以使用FastAPI的内置特性，它会自动生成一个Swagger文档。这个Swagger文档是基于OpenAPI标准的，可以被Swagger UI所使用。为了在FastAPI应用中启用Swagger UI，需要做几个步骤。首先，FastAPI会自动...

swagger文档离线导出,word、pdf、html

01-19

Swagger 文档离线导出功能则是为了在没有网络连接的情况下，依然能访问和使用 API 的详细信息。 Swagger 文档可以导出为多种格式，包括 Word（.docx）、PDF、HTML、SVG 和 XML。这些格式各有其用途： 1. **Word ...

swagger在线文档转成word文档

09-27

接下来，当Swagger2配置完成后，我们可以通过访问`http://localhost:8080/swagger-ui.html`来查看生成的在线文档。这个页面展示了所有API的详细信息，包括路径、方法、参数等。要将Swagger的在线文档转换为Word...

spring boot 加入拦截器后swagger不能访问问题

01-20

前言想让项目中所有请求都必须携带权限认证信息才能请求，所以给项目配置了拦截器，配置完拦截器之后发现swagger地址访问不了了，没有加之前是可以正常访问的。不能访问的原因小编分析了一下原因，拦截器要求所有请求（如get，post）都携带权限认证信息请求，但是swagger地址打开的时候默认是以get方式请求的，这个时候并不没有权限认证信息携带着，所以被拦截器给拦截了。既然这样那我是不是就可以把swagger地址过滤掉，意思是不拦截swagger地址，或者把它当成是一个静态资源去访问。原创文章 200获赞 250访问量 10万+

本地Swagger无法访问

Xx134的博客

08-18

1954

3.瞅瞅你的服务，有咩有这个配置，这玩意等于给你的地址又加了一截，所以你的访问地址要变为：http://localhost:8080/demo/swagger-ui.html# (我是因为这个，一丢丢难受)(该访问地址格式适用于 3.0版本以下的)-- swagger 依赖-->2.检查配置类，有没有漏注解。1.确定依赖有没有漏的。

配置好swagger2之后访问不到的问题

qq_44688861的博客

02-20

7115

项目场景：再做博瑞网站的时候，需要接口文档，之前都是用swagger2 问题描述：今天我也是配置好了swagger2,但是发现访问页面出现了404的状况原因分析：没有配置静态资源的映射，因为静态资源的保护，导致没有配置就会出现找不到的情况。解决方案：配置静态资源 @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResource

swagger访问失败问题

baidu_41909845的博客

02-15

637

swagger无法访问时，出现此提示，解决方案

Swagger访问不了的一种解决方案

qq_43243842的博客

08-13

2779

这是众多访问不了的情况其中的一种，如果不符合你的问题，请再看看别人的文章。项目是前后端分离代码中出现@Override下面这个方法导致swagger请求进不来把它注释掉 public void addViewControllers ...

swagger访问不了或者报fail

四书五经

02-02

3980

Hi，大家好，我是一个爱冒泡的程序猿都是小小的问题，但是却是绊了小编一脚???? 记录记录，通通记录下来都是项目实战哦问题描述：把本地spring boot项目启动，无任何报错信息。使用swagger访问路径，http://host:port/swagger-ui.html，访问不了或报fail、debug不到自己本地项目的代码里从图中可以很直接的看出，输入的地址是本地的localhost，点击try结果跑到10.25.108.23:8012上了原因分析：根据种种迹象，还是从swag

关于使用swagger时出现在浏览器输入网址无法访问的问题

m0_63445035的博客

10-11

7923

解决使用swagger时，无法访问的问题

swagger访问不了的解决方案 http://localhost:8080/swagger-ui/index.html

BillKu的博客

06-27

1266

这表明您的请求被服务器拒绝，原因是。再点击刷新，显示该网页无法正常远行。将 swagger 增加进白名单。根据浏览器控制台的错误信息。控制台上输出 401 状态。

解决Swagger3接口文档无法访问

一起加油吧！

11-26

2851

解决方法是在WebMvcConfig 配置类中重写WebMvcConfigurationSupport 中的addResourceHandlers 方法，设置静态资源映射。如果项目中整合了 SpringSecurity6 ，则还需要在SecurityConfig 配置类中为静态资源放行。

security设置swagger文档匿名访问

04-22

为了设置Swagger文档的匿名访问，您可以在Swagger配置文件中添加以下代码： ``` @Bean public SecurityConfiguration securityInfo() { return new SecurityConfiguration(null, null, null, null, "Bearer access...