如何在使用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 檔案。