* 📣 `Request` 🔢 *➡ 🛠️* 👈 🔜 📨 📄.
* ⚙️ `templates` 👆 ✍ ✍ & 📨 `TemplateResponse`, 🚶♀️ `request` 1️⃣ 🔑-💲 👫 Jinja2️⃣ "🔑".
-```Python hl_lines="4 11 15-16"
+```Python hl_lines="4 11 15-18"
{!../../../docs_src/templates/tutorial001.py!}
```
* Import `Jinja2Templates`.
* Create a `templates` object that you can re-use later.
* Declare a `Request` parameter in the *path operation* that will return a template.
-* Use the `templates` you created to render and return a `TemplateResponse`, passing the `request` as one of the key-value pairs in the Jinja2 "context".
+* Use the `templates` you created to render and return a `TemplateResponse`, pass the name of the template, the request object, and a "context" dictionary with key-value pairs to be used inside of the Jinja2 template.
-```Python hl_lines="4 11 15-16"
+```Python hl_lines="4 11 15-18"
{!../../../docs_src/templates/tutorial001.py!}
```
!!! note
- Notice that you have to pass the `request` as part of the key-value pairs in the context for Jinja2. So, you also have to declare it in your *path operation*.
+ Before FastAPI 0.108.0, Starlette 0.29.0, the `name` was the first parameter.
+
+ Also, before that, in previous versions, the `request` object was passed as part of the key-value pairs in the context for Jinja2.
!!! tip
By declaring `response_class=HTMLResponse` the docs UI will be able to know that the response will be HTML.
## Templates and static files
-And you can also use `url_for()` inside of the template, and use it, for example, with the `StaticFiles` you mounted.
+You can also use `url_for()` inside of the template, and use it, for example, with the `StaticFiles` you mounted.
```jinja hl_lines="4"
{!../../../docs_src/templates/templates/item.html!}
@app.get("/items/{id}", response_class=HTMLResponse)
async def read_item(request: Request, id: str):
- return templates.TemplateResponse("item.html", {"request": request, "id": id})
+ return templates.TemplateResponse(
+ request=request, name="item.html", context={"id": id}
+ )
"Topic :: Internet :: WWW/HTTP",
]
dependencies = [
- "starlette>=0.28.0,<0.29.0",
+ "starlette>=0.29.0,<0.33.0",
"pydantic>=1.7.4,!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0",
"typing-extensions>=4.8.0",
- # TODO: remove this pin after upgrading Starlette 0.31.1
- "anyio>=3.7.1,<4.0.0",
]
dynamic = ["version"]