静态文件¶
您可以使用 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 关于静态文件的文档。