happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Add HTML media type to template docs (#1690) 

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
Francesco Frassinelli 2020-08-03 09:53:56 +02:00 committed by GitHub
parent 1df2f14c64
commit 769ee73240
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/en/docs/advanced/templates.md
View File

@ -39,13 +39,16 @@ $ pip install aiofiles
* Declare a `Request` parameter in the *path operation* that will return a template. * 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`, 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!} {!../../../docs_src/templates/tutorial001.py!}
``` ```
!!! note !!! 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*. 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" !!! note "Technical Details"
You could also use `from starlette.templating import Jinja2Templates`. You could also use `from starlette.templating import Jinja2Templates`.

3
docs_src/templates/tutorial001.py
View File

@ -1,4 +1,5 @@
from fastapi import FastAPI, Request from fastapi import FastAPI, Request
from fastapi.responses import HTMLResponse
from fastapi.staticfiles import StaticFiles from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates from fastapi.templating import Jinja2Templates
@ -10,6 +11,6 @@ app.mount("/static", StaticFiles(directory="static"), name="static")
templates = Jinja2Templates(directory="templates") templates = Jinja2Templates(directory="templates")
@app.get("/items/{id}") @app.get("/items/{id}", response_class=HTMLResponse)
async def read_item(request: Request, id: str): async def read_item(request: Request, id: str):
return templates.TemplateResponse("item.html", {"request": request, "id": id}) return templates.TemplateResponse("item.html", {"request": request, "id": id})