如何使用 StaticFiles 在 FastAPI 的根路径处提供自定义 HTML 文件？

如何在使用 StaticFiles 时在 FastAPI 根路径中加载与 index.html 不同的文件？

问题

在提供静态服务的 FastAPI 应用程序中使用 StaticFiles 的文件，对根路径的请求将返回 index.html，而不是在单独的 @app.get("/") 中指定的自定义 HTML 文件。

解决方案

根据StaticFiles 的 Starlette 文档：

html - 以 HTML 模式运行。如果目录存在index.html，则自动加载该文件。

要解决此问题，请将 StaticFiles 实例挂载到不同的路径，例如 /static，而不是 /（根路径），如下所示：

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles
from fastapi.responses import FileResponse

app = FastAPI()

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

@app.get('/')
async def index() -> FileResponse:
    return FileResponse('static/custom.html', media_type='html')

顺序问题

挂载和定义端点的顺序至关重要：

• 如果在定义 @app.get("/" 后挂载 StaticFiles ) 端点，index.html 不会自动加载。
• 如果 StaticFiles 在所有其他端点之前挂载，它将根据其优先级处理所有请求。

html=True选项

设置 html=True 简化了在一行中提供 Web 内容目录的过程。但是，对于动态内容或其他端点，请考虑使用模板并将 StaticFiles 安装到不同的路径，而不使用 html=True。

以上是如何使用 StaticFiles 在 FastAPI 的根路径处提供自定义 HTML 文件？的详细内容。更多信息请关注PHP中文网其他相关文章！