【FastAPI】内网/离线环境docs文档无法显示的解决方案
通过将 FastAPI 的资源转为静态,解决 docs文档无法正常显示的问题
·
FastAPI doc文档解决方案

🎬 博主名称: 超级苦力怕
🔥 个人专栏: 《问题解决方案》
🚀 每一次思考都是突破的前奏,每一次复盘都是精进的开始!
1. 错误原因
FastAPI 中的文档页面都依赖外部 CDN,如果你想在断开的网络上运行,会有问题。因此,我们可以通过安装额外包,将文档部分换成静态资源,让 FastAPI 实例配置使用这些文件即可,这本质上只是自动化了官方文档中描述的流程。
适用于:内网、离线环境、或需要完全隔离的网络中。
拓展:CDN(内容分发网络) 就是将静态资源复制到全球的边缘节点服务器上,用户访问会自动跳转到最近的节点获取资源,而非直接访问服务器。
2. 解决方案:使用静态资源
解决方案:让文档相关的静态资源从本地加载,步骤如下:
- 在命令提示符安装额外包
pip install fastapi-offline

2. 将实例配置的 FastAPI 替换为 FastAPIOffline,此时重新访问即可。
from fastapi_offline import FastAPIOffline
# app = FastAPI()
app = FastAPIOffline()

这本质上只是自动化了官方文档中描述的流程,因此,其他代码不需要改变就能正常使用。
总结
| 步骤 | 操作 |
|---|---|
| 1 | 安装依赖:pip install fastapi-offline |
| 2 | 替换导入:from fastapi_offline import FastAPIOffline |
| 3 | 修改实例化:app = FastAPIOffline() |
适用于内网/离线环境,让文档从本地静态资源加载。
参考网站:fastAPI-离线

更多推荐
所有评论(0)