テンプレート¶

FastAPI では、任意のテンプレートエンジンを使用できます。

一般的な選択肢は Jinja2 で、Flask や他のツールで使用されているのと同じものです。

FastAPI アプリケーションで直接使用できる、簡単に設定するためのユーティリティがあります（Starlette によって提供されています）。

依存関係をインストールする¶

仮想環境を作成し、アクティブ化して、jinja2 をインストールしてください

$ pip install jinja2

---> 100%

`Jinja2Templates` を使用する¶

Jinja2Templates をインポートします。
後で再利用できる templates オブジェクトを作成します。
テンプレートを返す *パス操作* で Request パラメータを宣言します。
作成した templates を使用して TemplateResponse をレンダリングして返します。テンプレートの名前、リクエストオブジェクト、および Jinja2 テンプレート内で使用されるキーと値のペアを持つ「コンテキスト」辞書を渡します。

from fastapi import FastAPI, Request
from fastapi.responses import HTMLResponse
from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates

app = FastAPI()

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


templates = Jinja2Templates(directory="templates")


@app.get("/items/{id}", response_class=HTMLResponse)
async def read_item(request: Request, id: str):
    return templates.TemplateResponse(
        request=request, name="item.html", context={"id": id}
    )

注

FastAPI 0.108.0、Starlette 0.29.0 より前では、name が最初のパラメータでした。

また、それより前のバージョンでは、request オブジェクトは Jinja2 のコンテキストのキーと値のペアの一部として渡されていました。

ヒント

response_class=HTMLResponse を宣言することで、ドキュメント UI はレスポンスが HTML であることを認識できます。

「技術的な詳細」

from starlette.templating import Jinja2Templates を使用することもできます。

FastAPI は、開発者の便宜のために、starlette.templating を fastapi.templating と同じように提供しています。ただし、利用可能なレスポンスのほとんどは Starlette から直接提供されています。Request や StaticFiles も同様です。