Skip to content

静态文件

你可以使用 StaticFiles 自动从一个目录提供静态文件。

使用 StaticFiles

  • 导入 StaticFiles。
  • 在特定路径上“挂载”一个 StaticFiles() 实例。
from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

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

"技术细节"

你也可以使用 from starlette.staticfiles import StaticFiles。

FastAPI 提供了与 starlette.staticfiles 相同的 fastapi.staticfiles，只是为了方便你，开发者。但它实际上直接来自 Starlette。

什么是“挂载”

“挂载”意味着在一个特定路径上添加一个完整的“独立”应用程序，然后它负责处理所有子路径。

这与使用 APIRouter 作为挂载应用程序不同，因为挂载的应用程序是完全独立的。主应用程序的 OpenAPI 和文档不会包含挂载应用程序的任何内容，等等。

你可以在高级用户指南中阅读更多关于这方面的内容。

详细信息

第一个 "/static" 指的是这个“子应用程序”将被“挂载”的子路径。因此，任何以 "/static" 开头的路径都将由它处理。

directory="static" 指的是包含你的静态文件的目录名称。

name="static" 为它提供了一个可以在 FastAPI 内部使用的名称。

所有这些参数都可以不同于 "static"，根据你自己的应用程序的需求和具体细节进行调整。

更多信息

有关更多详细信息和选项，请查看 Starlette 关于静态文件的文档。