FastAPI 静态文件服务:快速配置与挂载 HTML
推荐阅读 📚🎓🧑🏫
[1] 一起学Python 专栏:深入探讨 Python 编程,涵盖基础与进阶内容,以及 NumPy、Pandas、Matplotlib、Docker、Linux 等实用技术。
FastAPI 提供了方便的静态文件服务配置,通过 StaticFiles
实现静态资源的挂载。开发者可以将静态文件目录挂载到指定路径,FastAPI 会自动处理文件的请求。例如,使用 app.mount("/static", StaticFiles(directory="static"), name="static")
可以将位于 static
目录下的静态文件提供给前端访问。这样,所有以 /static
开头的请求将被 FastAPI 自动处理,方便访问静态文件如 HTML、CSS、JavaScript 文件等。静态文件服务非常适用于展示页面或提供静态资源支持,且与主应用的 API 接口和文档无关,简洁且高效。
文章目录
以下示例中使用的 Python 版本为 Python 3.10.15
,FastAPI 版本为 0.115.4
。
一 示例代码
from fastapi import FastAPI # 导入 FastAPI 类
from fastapi.staticfiles import StaticFiles # 导入 StaticFiles,用于提供静态文件
app = FastAPI() # 创建 FastAPI 应用实例
# 挂载静态文件服务
# 将 StaticFiles 实例挂载到 "/static" 路径,所有以 "/static" 开头的请求都会由 StaticFiles 处理
# directory="static" 指定静态文件所在的目录,这里是名为 "static" 的目录
# name="static" 提供给这个挂载点的内部名称,便于应用内部引用
app.mount("/static", StaticFiles(directory="static"), name="static")
运行代码文件 ot02.py 来启动应用:
$ uvicorn ot02:app --reload
在 SwaggerUI 中可以查看在线文档:http://127.0.0.1:8000/docs
。
静态资源文件目录
your-project
├── other
│ └── static
│ │ ├── h1.html
│ └── ot02.py
请求:
GET /static/h1.html HTTP/1.1
Accept: */*
Accept-Encoding: deflate, gzip
User-Agent: your-agent
Host: 127.0.0.1
响应:
HTTP/1.1 200 OK
accept-ranges: bytes
content-length: 151
content-type: text/html; charset=utf-8
server: uvicorn
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>your-title</title>
</head>
<body>
Hello World ! 哈哈~
</body>
</html>
二 StaticFiles 挂在静态文件
from fastapi.staticfiles import StaticFiles
app.mount("/static", StaticFiles(directory="static"), name="static")
使用 StaticFiles
时,导入StaticFiles并将 StaticFiles()
实例挂载到指定路径。也可以使用 from starlette.staticfiles import StaticFiles
。FastAPI 提供了与 starlette.staticfiles
相同的 fastapi.staticfiles
,只是为了方便开发。
三 什么是 “挂载” (Mounting)
# 挂载静态文件服务
# 将 StaticFiles 实例挂载到 "/static" 路径,所有以 "/static" 开头的请求都会由 StaticFiles 处理
# directory="static" 指定静态文件所在的目录,这里是名为 "static" 的目录
# name="static" 提供给这个挂载点的内部名称,便于应用内部引用
app.mount("/static", StaticFiles(directory="static"), name="static")
"挂载"是将一个独立的应用添加到特定路径,负责处理所有子路径,且与主应用的 OpenAPI 和文档无关。
四 完整代码示例
from fastapi import FastAPI # 导入 FastAPI 类
from fastapi.staticfiles import StaticFiles # 导入 StaticFiles,用于提供静态文件
app = FastAPI() # 创建 FastAPI 应用实例
# 挂载静态文件服务
# 将 StaticFiles 实例挂载到 "/static" 路径,所有以 "/static" 开头的请求都会由 StaticFiles 处理
# directory="static" 指定静态文件所在的目录,这里是名为 "static" 的目录
# name="static" 提供给这个挂载点的内部名称,便于应用内部引用
app.mount("/static", StaticFiles(directory="static"), name="static")
五 源码地址
六 参考
[1] FastAPI 官方文档