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

📝 Update includes in `docs/en/docs/tutorial/cookie-param-models.md` (#12639)

This commit is contained in:
VISHNU V S 2024-11-09 20:59:53 +05:30 committed by GitHub
parent 0c449748ff
commit 35506c1f59
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
docs/en/docs/tutorial/cookie-param-models.md
View File

@ -20,57 +20,7 @@ This same technique applies to `Query`, `Cookie`, and `Header`. 😎
Declare the **cookie** parameters that you need in a **Pydantic model**, and then declare the parameter as `Cookie`:
//// tab | Python 3.10+
```Python hl_lines="9-12 16"
{!> ../../docs_src/cookie_param_models/tutorial001_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="9-12 16"
{!> ../../docs_src/cookie_param_models/tutorial001_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="10-13 17"
{!> ../../docs_src/cookie_param_models/tutorial001_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="7-10 14"
{!> ../../docs_src/cookie_param_models/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="9-12 16"
{!> ../../docs_src/cookie_param_models/tutorial001.py!}
```
////
{* ../../docs_src/cookie_param_models/tutorial001_an_py310.py hl[9:12,16] *}
**FastAPI** will **extract** the data for **each field** from the **cookies** received in the request and give you the Pydantic model you defined.
@ -100,35 +50,7 @@ Your API now has the power to control its own <abbr title="This is a joke, just
You can use Pydantic's model configuration to `forbid` any `extra` fields:
//// tab | Python 3.9+
```Python hl_lines="10"
{!> ../../docs_src/cookie_param_models/tutorial002_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="11"
{!> ../../docs_src/cookie_param_models/tutorial002_an.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="10"
{!> ../../docs_src/cookie_param_models/tutorial002.py!}
```
////
{* ../../docs_src/cookie_param_models/tutorial002_an_py39.py hl[10] *}
If a client tries to send some **extra cookies**, they will receive an **error** response.