如何将自定义 HTML 文件作为 FastAPI 根路径？

将自定义 HTML 文件作为 FastAPI 根路径

您的目标是将自定义 HTML 文件（例如 custom.html）渲染为 FastAPI 应用程序的根路径。但是，您当前的设置会导致返回默认的 index.html。

Index.html 返回的原因

如 StaticFiles 上的 Starlette 文档中所述：

html - Run in HTML mode. Automatically loads index.html for directories if such file exists.

解决方案

要解决此问题，您有两个选项：

1。将 StaticFiles 挂载到不同的路径：

将您的 StaticFiles 实例挂载到唯一的路径，例如 /static。这可确保任何以 /static 开头的路径都由 StaticFiles 应用程序处理。

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

2.在端点之后定义 StaticFiles：

如果您仍想将 StaticFiles 挂载到根路径 (/)，请在声明所有 API 端点后定义 StaticFiles 实例。这可确保端点优先于 StaticFiles。

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

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

html=True Option

html=True 参数可以使用一行代码轻松提供静态 Web 内容。但是，如果您需要动态 HTML 文件和其他 API 端点，请考虑使用模板并将 StaticFiles 安装到不同的路径，而不使用 html=True。

以上是如何将自定义 HTML 文件作为 FastAPI 根路径？的详细内容。更多信息请关注PHP中文网其他相关文章！