解决fastapi访问/docs和/redoc接口文档显示空白或无法加载

这个问题是由于fastapi内置的接口文档使用的外网的cdn
在这里插入图片描述
我们在浏览器开发者工具中可以看到它请求了一个js脚本,这个脚本部署在国外,国内无法访问,导致页面卡死在这里,显示空白。

知道这个以后,我们可以讲这些静态资源配置到自己的本地,这些静态资源都在github上开源。
链接: swagger-ui
链接: redoc
上面两个链接分别是fastapi两种模式下文档接口所需的静态资源开源地址。

将静态资源下载后放到项目的根目录下,像下图这样
在这里插入图片描述
然后我们需要在python解释器环境(或虚拟环境)下Lib/site-package/fastapi/openapi/docs.py文件

修改里面的静态资源访问路径

在这里插入图片描述
在这里插入图片描述
可以注释文件原有的部分内容,再将复制下面的内容复制进去:

swagger_js_url: str="/static/swagger-ui/swagger-ui-bundle.js",
swagger_css_url: str="/static/swagger-ui/swagger-ui.css",
swagger_favicon_url: str="/static/swagger-ui/favicon.png",

redoc_js_url: str = "/static/redoc/bundles/redoc.standalone.js",
redoc_favicon_url: str = "/static/redoc/favicon.png"

注意这里的路径需要与fastapi启动文件开始
在这里插入图片描述

最后在主程序中添加如下代码:
在这里插入图片描述

app.mount('/static', StaticFiles(directory='static'),
          name='static')	

告诉fastapi以/static开始的路径从static目录中找。

如果你的项目结构(静态资源目录)和docs.py配置与笔者完全相同,那么你再次启动时访问/docs和/redoc就应该不会有问题了。(如果你修改了静态资源目录结构,你需要对应修改docs.py中对应的路由)

成功运行结果如下:
在这里插入图片描述

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值