StaticFiles を使用しながら FastAPI ルート パスで特定の HTML ファイルを提供する方法

静的ファイルを提供するために FastAPI と StaticFiles を使用する場合、デフォルトのindex.htmlではなく、ルートパスに別のHTMLファイル(例:custom.html)をロードしたいシナリオが発生する可能性があります。これは、FastAPI のルーティングと StaticFiles 機能の特定の側面を理解することで実現できます。

StaticFiles について

Starlette のドキュメントによると、StaticFiles は、静的ファイルの提供を処理するミドルウェアです。指定されたディレクトリ。 html=True が設定されている場合、ディレクトリ内のindex.html ファイルが自動的に検索され、それに応じて提供されます。

マウント順序

静的ファイルのマウントと定義の順序。エンドポイントは重要な役割を果たします。 StaticFiles がルート パス (/) にマウントされ、エンドポイントより前に定義されている場合、カスタム エンドポイントが後で定義されている場合でも、StaticFiles が優先され、すべてのリクエストが処理されます。

ルート パスのカスタマイズ

ルート パスで特定の HTML ファイルを提供するには、次の手順に従う必要があります:

1. 静的ファイルを別のパス (例: /static) にマウントします。 :

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

2. 目的の HTML ファイルを返すカスタム エンドポイントを作成します:

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

3. エンドポイントの優先順位を確保するために、カスタム エンドポイントを定義した後に静的ファイルをマウントします。

追加の考慮事項

• custom.html が StaticFiles マウント パスで指定された正しいディレクトリにあることを確認してください。
• StaticFiles がリクエストを処理し、リクエストされたパスを持つファイルが見つからない場合は、 404 Not Found 応答を返します。
• FileResponse の代わりにテンプレートを使用すると、HTML ファイルを動的に更新するための柔軟性が高まります。