FastAPI：docs文档无法加载的解决办法

最新推荐文章于 2025-04-03 18:45:00 发布
最新推荐文章于 2025-04-03 18:45:00 发布
阅读量7.5k 收藏 1
点赞数 2
分类专栏： FastAPI 文章标签： python 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_44683653/article/details/107542463
版权
FastAPI用户遇到Swagger-ui3.30.1版本导致API文档加载问题。FastAPI作者发布0.60.1版本，更换为swagger-ui3.30.0，修复文档加载问题。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

最近使用FastAPI开发的时候，发现自动生成的API交互文档居然加载不出来了？？ 于是去github上看了看，已经有人提出了这个的问题了：

      传送门
在这里插入图片描述

最后发现是Swagger-ui更新到3.30.1版本后导致部分用户无法完全加载API交互文档，不是FastAPI的问题

然后往下翻了翻，发现FastAPI的作者tiangolo在下面评论了：在这里插入图片描述

他发布了一个fastapi新的release版本0.60.1，更换了之前fastapi使用的swagger-ui，换成了它的上个可用版本，也就是：swagger-ui 3.30.0

所以你要做的只是更新一下你的fastapi就行了：
pip install --upgrade fastapi

在这里插入图片描述
相信这个问题很快就会得到swagger-ui官方的解决。

python系列：一文读懂FastAPI：Python 开发者的福音
weixin_54626591的博客
06-04 1418
一文读懂FastAPI：Python 开发者的福音
FastAPI--如何自定义Docs UI，包括多个APP、静态资源、元数据等
penriver的博客
09-17 649
FastAPI--如何自定义Docs UI，包括多个APP、静态资源、元数据等
FastAPI访问/docs接口文档显示空白、js/css无法加载
jaket5219999的博客
12-14 7321
FastAPI的接口文档页面空白，可考虑使用插件fastapi-cdn-host来解决，只需增加一行代码即可：fastapi_cdn_host.patch_docs(app)
关于“python中，fastapi访问/docs接口，页面空白或者页面缓冲慢”的问题
MITA1的博客
04-10 1494
项目中用fastapi或者其他框架搭建web服务后，运行服务器，打开http://127.0.0.1:8000/docs页面空白，但是在服务器端显示“"GET /docs HTTP/1.1" 200 OK”访问成功。浏览器端无法查看页面进行下一步的调试。
fastapi完全离线环境（无外网）的访问Swagger所做特殊处理
最新发布
yhj198927的博客
04-03 583
在互联网环境中，只要 启动FastAPI 服务运行在本地机器上，访问（Swagger UI）就可以访问到Swagger界面，但是在完全离线环境（无外网）下如何访问Swagger页面呢？默认情况下，Swagger UI 会从外部 CDN 加载 CSS 和 JavaScript 文件（如若机器完全无法访问外网，会导致 Swagger UI 样式丢失。：配置 FastAPI 使用本地资源。
fastapi后台页面文档docs打不开的问题解决！！！
shzbbsns的博客
06-27 1125
对于1.0.0以下的版本执行下面这步即可把static文件放到本地并且修改openapi里面docs文件，把swagger路径改为本地。
FastAPI 自动生成的docs文档没法使用
楼上小宇_home
07-23 3633
FastAPI 自动生成的docs文档没法使用，当展开路径时候一直在转圈，具体就是这样 这个是由于swagger-ui 3.30.1 中的bug导致，具体bug可以看这里 我们可以通过在FastAPI中指定低版本的swagger-ui 来解决这个问题，主要方法是在main.py的文件中加上如下代码： from fastapi import applications from fastapi.openapi.docs import get_swagger_ui_html def swagger_monk
FastAPI访问docs显示空白/加载失败
lbbhhh的博客
11-13 1983
遇到FastAPI访问接口文档/docs时页面显示空白的问题，直接使用原博主封装好的包即可，快捷迅速解决问题。
fastapi访问/docs和/redoc接口文档显示空白或无法加载
m0_52726759的博客
05-19 5931
这个问题是由于fastapi内置的接口文档使用的外网的cdn 我们在浏览器开发者工具中可以看到它请求了一个js脚本，这个脚本部署在国外，国内无法访问，导致页面卡死在这里，显示空白。 知道这个以后，我们可以讲这些静态资源配置到自己的本地，这些静态资源都在github上开源。 swagger-ui redoc 上面两个链接分别是fastapi两种模式下文档接口所需的静态资源开源地址。 这里我抽取出我们所需要的最少的资源放在我的百度网盘。 提取码：33kh 将静态资源下载后放到项目的根目录下，
FastAPI交互文档不显示的问题
Mr.Guo的博客
12-27 1201
当安装好fastapi，使用交互文档时，默认的页面静态文件是从CDN获取，就会有打开速度慢或者打不开的问题，通过以下三步修改。
一文读懂FastAPI：Python开发者的福音！
qq_67344578的博客
04-25 2243
接下来，我们可以定义我们的接口。"}在上面的例子中，我们定义了一个GET请求的接口，路径为"/hello"。当访问这个接口时，会返回一个包含"message"字段的JSON响应。使用FastAPI可以快速、简单地开发API接口，并且利用自动生成的文档功能方便地查看接口文档。通过以上几个简单的步骤，我们可以快速上手FastAPI，并开始构建高性能的API应用。
fastapi 无法正常加载可视化API文档界面的/docs网页本地显示
weixin_42095166的博客
05-20 1020
重置docs_url# 挂载相关静态资源文件，正常访问/docs
FastAPI Swagger文档打不开解决办法
希望我的分享能让你今天有所收获！
06-06 1579
FastAPI Swagger文档打不开解决办法
fastapi docs打开为空白解决办法
长城郭靖的专栏
07-11 2400
使用的cdn为国外cdn。
FastApI接口文档无法访问
平时不搬砖的博客
03-19 2899
python中Fast API的使用教程， 接口文档无法访问的三种处理方式
解决fastapi访问/docs和/redoc接口文档显示空白或无法加载
weixin_43936332的博客
06-03 6328
如果你的项目结构（静态资源目录）和docs.py配置与笔者完全相同，那么你再次启动时访问/docs和/redoc就应该不会有问题了。（如果你修改了静态资源目录结构，你需要对应修改docs.py中对应的路由）我们在浏览器开发者工具中可以看到它请求了一个js脚本，这个脚本部署在国外，国内无法访问，导致页面卡死在这里，显示空白。知道这个以后，我们可以讲这些静态资源配置到自己的本地，这些静态资源都在github上开源。这个问题是由于fastapi内置的接口文档使用的外网的cdn。修改里面的静态资源访问路径。
【Python】Fastapi swagger-ui.css 、swagger-ui-bundle.js 无法加载，docs无法加载，redocs无法使用
q742971636的博客
11-23 2615
使用fastapi的时候，swagger-ui.css 、swagger-ui-bundle.js、redoc.standalone.js 有时候无法加载（国内环境原因或者是局域网屏蔽），此时就需要自己用魔法下载好对应文件，然后替换到fastapi里面去。
解决基于FastAPI Swagger UI的文档打不开的问题
小龙在线
02-08 1153
基于FastAPI Swagger UI的文档链接和在没有外网的状态下无法打开，原因是Swagger依赖的JS和CSS来自CDN。 FastAPI可以配置这些链接地址，改为本地目录下，自定义Javascript和CSS的CDN地址： 文件下载地址：
fastapi 实践（三）Swagger Docs
cliffordl的专栏
03-21 719
这个文档是自动生成的，基于 OpenAPI 规范，支持 Swagger UI 和 ReDoc 两种交互式界面。FastAPI 提供了内置的交互式 API 文档，使开发者能够轻松了解和测试 API 的各个端点。通过 FastAPI 的交互式 API 文档，开发者能够更轻松地理解和使用 API，提高开发效率。在运行 FastAPI 应用时，Uvicorn 同时启动了交互式 API 文档服务。从报错，就很明显，是因为 swagger 的接口被内部权限拦截了。下载 fastapi-cdn-host包。
fastapi-docs接口泄露
03-21
### FastAPI 文档接口泄漏及其解决方案 FastAPI 是一种现代、快速（高性能）、基于 Python 的 Web 框架，它提供了自动生成交互式 API 文档的功能，例如 Swagger UI 和 ReDoc。这些工具极大地简化了开发人员的工作流程，但也可能带来潜在的安全风险。 #### 安全隐患分析 如果未正确配置，Swagger UI 或 ReDoc 可能会暴露敏感信息给未经授权的用户。默认情况下，FastAPI 提供的 `/docs` 和 `/redoc` 接口允许任何人访问并查看 API 结构[^1]。这可能导致以下安全问题： - 敏感端点被公开。 - 数据模型结构被披露。 - 攻击者可以利用此信息尝试进一步攻击系统。 #### 解决方案与预防措施 为了防止此类安全隐患，开发者可以通过多种方式来保护文档接口。 ##### 方法一：禁用生产环境中的文档接口 在生产环境中完全移除或禁用自动文档功能是一种简单有效的策略。通过设置 `include_in_schema=False` 参数或者不加载相关中间件即可实现这一目标。 ```python from fastapi import FastAPI app = Fastapi(docs_url=None, redoc_url=None) # Disable both /docs and /redoc endpoints. ``` 上述代码片段展示了如何关闭这两个路径以减少不必要的曝光风险[^2]。 ##### 方法二：使用身份验证限制访问权限 另一种方法是对文档页面实施基本的身份验证机制，仅允许特定角色或经过认证后的请求才能浏览相关内容。 ```python from fastapi import Depends, HTTPException, status from fastapi.security import HTTPBasic, HTTPBasicCredentials security = HTTPBasic() def get_current_username(credentials: HTTPBasicCredentials = Depends(security)): correct_username = "admin" correct_password = "secret" if credentials.username != correct_username or credentials.password != correct_password: raise HTTPException( status_code=status.HTTP_401_UNAUTHORIZED, detail="Incorrect username or password", headers={"WWW-Authenticate": "Basic"}, ) return credentials.username @app.get("/protected-docs/") async def read_protected_docs(username: str = Depends(get_current_username)): return {"message": f"Welcome {username} to the protected docs!"} ``` 这里定义了一个简单的用户名密码校验逻辑作为示例说明[^3]。实际应用中建议采用更复杂且安全的方式比如 OAuth2 流程来进行授权控制。 ##### 方法三：IP 地址白名单过滤 还可以考虑依据客户端 IP 来决定是否展示文档服务。这种方法适用于内部网络部署场景下对外部互联网隐藏细节的情况。 ```python import uvicorn from starlette.middleware.base import BaseHTTPMiddleware from typing import Callable class WhitelistMiddleware(BaseHTTPMiddleware): async def dispatch(self, request, call_next): allowed_ips = ["192.168.1.1", "::1"] # Add your internal IPs here client_host = request.client.host if client_host not in allowed_ips: return Response("Access denied.", media_type='text/plain', status_code=403) response = await call_next(request) return response app.add_middleware(WhitelistMiddleware) ``` 以上脚本创建了一个基础版的 IP 白名单位置管理器，并将其应用于整个应用程序实例上[^4]。 综上所述，针对 FastAPI 自带文档系统的安全性考量应当重视起来，在不同阶段采取适当手段加以防护是非常必要的。
评论 14
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值