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/body.md` (#12586)

This commit is contained in:
Nomad Monad 2024-10-27 16:58:19 +00:00 committed by GitHub
parent 75af54babd
commit 5a0e13794b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
docs/en/docs/tutorial/body.md
View File

@ -22,21 +22,7 @@ As it is discouraged, the interactive docs with Swagger UI won't show the docume
First, you need to import `BaseModel` from `pydantic`:
//// tab | Python 3.10+
```Python hl_lines="2"
{!> ../../docs_src/body/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="4"
{!> ../../docs_src/body/tutorial001.py!}
```
////
{* ../../docs_src/body/tutorial001_py310.py hl[2] *}
## Create your data model
@ -44,21 +30,8 @@ Then you declare your data model as a class that inherits from `BaseModel`.
Use standard Python types for all the attributes:
//// tab | Python 3.10+
{* ../../docs_src/body/tutorial001_py310.py hl[5:9] *}
```Python hl_lines="5-9"
{!> ../../docs_src/body/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="7-11"
{!> ../../docs_src/body/tutorial001.py!}
```
////
The same as when declaring query parameters, when a model attribute has a default value, it is not required. Otherwise, it is required. Use `None` to make it just optional.
@ -86,21 +59,7 @@ For example, this model above declares a JSON "`object`" (or Python `dict`) like
To add it to your *path operation*, declare it the same way you declared path and query parameters:
//// tab | Python 3.10+
```Python hl_lines="16"
{!> ../../docs_src/body/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="18"
{!> ../../docs_src/body/tutorial001.py!}
```
////
{* ../../docs_src/body/tutorial001_py310.py hl[16] *}
...and declare its type as the model you created, `Item`.
@ -167,21 +126,7 @@ It improves editor support for Pydantic models, with:
Inside of the function, you can access all the attributes of the model object directly:
//// tab | Python 3.10+
```Python hl_lines="19"
{!> ../../docs_src/body/tutorial002_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="21"
{!> ../../docs_src/body/tutorial002.py!}
```
////
## Request body + path parameters
@ -189,21 +134,8 @@ You can declare path parameters and request body at the same time.
**FastAPI** will recognize that the function parameters that match path parameters should be **taken from the path**, and that function parameters that are declared to be Pydantic models should be **taken from the request body**.
//// tab | Python 3.10+
{* ../../docs_src/body/tutorial003_py310.py hl[15:16] *}
```Python hl_lines="15-16"
{!> ../../docs_src/body/tutorial003_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="17-18"
{!> ../../docs_src/body/tutorial003.py!}
```
////
## Request body + path + query parameters
@ -211,21 +143,7 @@ You can also declare **body**, **path** and **query** parameters, all at the sam
**FastAPI** will recognize each of them and take the data from the correct place.
//// tab | Python 3.10+
```Python hl_lines="16"
{!> ../../docs_src/body/tutorial004_py310.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="18"
{!> ../../docs_src/body/tutorial004.py!}
```
////
{* ../../docs_src/body/tutorial004_py310.py hl[16] *}
The function parameters will be recognized as follows: