テンプレート¶

FastAPI では、お好きなテンプレートエンジンを使用できます。

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

FastAPI アプリケーションで直接使用できる（Starletteによって提供される）便利な設定ユーティリティがあります。

依存関係のインストール¶

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

$ pip install jinja2

---> 100%

`Jinja2Templates` の使用¶

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

Python 3.8+

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}
    )

Note

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 も同様です。