From 769ee73240da5586380bf0ca3cc3f3d8c2a2858a Mon Sep 17 00:00:00 2001 From: Francesco Frassinelli Date: Mon, 3 Aug 2020 09:53:56 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20HTML=20media=20type=20to?= =?UTF-8?q?=20template=20docs=20(#1690)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sebastián Ramírez --- docs/en/docs/advanced/templates.md | 5 ++++- docs_src/templates/tutorial001.py | 3 ++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/en/docs/advanced/templates.md b/docs/en/docs/advanced/templates.md index 871f3163f..59d2735cb 100644 --- a/docs/en/docs/advanced/templates.md +++ b/docs/en/docs/advanced/templates.md @@ -39,13 +39,16 @@ $ pip install aiofiles * 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". -```Python hl_lines="3 10 14 15" +```Python hl_lines="4 11 15 16" {!../../../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*. +!!! tip + By declaring `response_class=HTMLResponse` the docs UI will be able to know that the response will be HTML. + !!! note "Technical Details" You could also use `from starlette.templating import Jinja2Templates`. diff --git a/docs_src/templates/tutorial001.py b/docs_src/templates/tutorial001.py index b818861db..245e7110b 100644 --- a/docs_src/templates/tutorial001.py +++ b/docs_src/templates/tutorial001.py @@ -1,4 +1,5 @@ from fastapi import FastAPI, Request +from fastapi.responses import HTMLResponse from fastapi.staticfiles import StaticFiles from fastapi.templating import Jinja2Templates @@ -10,6 +11,6 @@ app.mount("/static", StaticFiles(directory="static"), name="static") templates = Jinja2Templates(directory="templates") -@app.get("/items/{id}") +@app.get("/items/{id}", response_class=HTMLResponse) async def read_item(request: Request, id: str): return templates.TemplateResponse("item.html", {"request": request, "id": id})