223 字
1 分钟

自定义Swagger UI本地资源

自定义Swagger UI本地资源#

FastAPI自带的文档系统调用的是CDN上的SwaggerUI资源文件。但是,存在访问错误等多种因素,会导致文档加载过慢或者加载不出来等情况。因此需要对文件资源进行自定义使用本地的资源降低对云端的依赖。

首先下载Swagger UI资源文件#

样式主要文件:https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css

JS主文件:https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js

将文件保存到静态目录,即static下。

并且挂在到应用上

from fastapi.staticfiles import StaticFiles
app.mount("/static",StaticFiles(directory="static"),name="static")

禁用原本的文档系统,添加自定义文件路径#

app = FastAPI(docs_url=None, redoc_url=None)
@app.get("/docs")
async def custom_swagger_ui_html():
return get_swagger_ui_html(
openapi_url="/openapi.json",
title="API Documentation",
swagger_css_url="/static/swagger-ui.css",
swagger_js_url="/static/swagger-ui-bundle.js"
)

配置数据库并安装SqlModel#

检查虚拟环境是否开启,并在虚拟环境下执行以下命令安装SqlModel包

pip install sqlmodel
# 安装指定数据库MySQL包
pip install pymysql

文章分享

如果这篇文章对你有帮助,欢迎分享给更多人!

自定义Swagger UI本地资源
https://firefly.cuteleaf.cn/posts/lireal/02day/
作者
Lireal
发布于
2026-01-21
许可协议
CC BY-NC-SA 4.0

目录