如何在使用 StaticFiles 时在 FastAPI 根路径中提供特定 HTML 文件

当使用 FastAPI 与 StaticFiles 一起提供静态文件时，您可能会遇到您想要在根路径中加载不同的 HTML 文件（例如，custom.html）而不是默认的 index.html 的情况。这可以通过了解 FastAPI 路由和 StaticFiles 功能的某些方面来实现。

了解 StaticFiles

根据 Starlette 的文档，StaticFiles 是一个中间件，用于处理来自以下位置的静态文件服务：指定的目录。当设置 html=True 时，它​​会自动在目录中查找 index.html 文件并相应地提供它们。

安装顺序

安装 StaticFiles 并定义您的静态文件的顺序端点起着至关重要的作用。如果 StaticFiles 挂载到根路径（即 /）并在任何端点之前定义，则它将优先处理所有请求，即使稍后定义自定义端点也是如此。

自定义根路径

要在根路径中提供特定的 HTML 文件，您需要遵循以下操作步骤：

1. 将 StaticFiles 挂载到单独的路径（例如 /static）：

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

2. 创建返回所需 HTML 的自定义端点文件：

   @app.get('/')
   async def index():
       return FileResponse('custom.html')

3. 定义自定义端点后挂载 StaticFiles 以确保端点优先级。

其他注意事项

• 确保 custom.html 位于 StaticFiles 挂载中指定的正确目录中path.
• 了解如果 StaticFiles 处理请求并且没有找到具有所请求路径的文件，它将返回 404 Not Found 响应。
• 使用 Templates 而不是 FileResponse 可以为动态更新 HTML 文件。