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

📝 Update includes for `docs/en/docs/tutorial/header-params.md` (#12640)

This commit is contained in:
VISHNU V S 2024-11-09 21:02:39 +05:30 committed by GitHub
parent 182cc4439e
commit 438343c376
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 218 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

222
docs/en/docs/tutorial/header-params.md
View File

@ -6,57 +6,7 @@ You can define Header parameters the same way you define `Query`, `Path` and `Co
First import `Header`:
//// tab | Python 3.10+
```Python hl_lines="3"
{!> ../../docs_src/header_params/tutorial001_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="3"
{!> ../../docs_src/header_params/tutorial001_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="3"
{!> ../../docs_src/header_params/tutorial001_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="1"
{!> ../../docs_src/header_params/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="3"
{!> ../../docs_src/header_params/tutorial001.py!}
```
////
{* ../../docs_src/header_params/tutorial001_an_py310.py hl[3] *}
## Declare `Header` parameters
@ -64,57 +14,7 @@ Then declare the header parameters using the same structure as with `Path`, `Que
You can define the default value as well as all the extra validation or annotation parameters:
//// tab | Python 3.10+
```Python hl_lines="9"
{!> ../../docs_src/header_params/tutorial001_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="9"
{!> ../../docs_src/header_params/tutorial001_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="10"
{!> ../../docs_src/header_params/tutorial001_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="7"
{!> ../../docs_src/header_params/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="9"
{!> ../../docs_src/header_params/tutorial001.py!}
```
////
{* ../../docs_src/header_params/tutorial001_an_py310.py hl[9] *}
/// note | "Technical Details"
@ -146,57 +46,7 @@ So, you can use `user_agent` as you normally would in Python code, instead of ne
If for some reason you need to disable automatic conversion of underscores to hyphens, set the parameter `convert_underscores` of `Header` to `False`:
//// tab | Python 3.10+
```Python hl_lines="10"
{!> ../../docs_src/header_params/tutorial002_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="11"
{!> ../../docs_src/header_params/tutorial002_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="12"
{!> ../../docs_src/header_params/tutorial002_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="8"
{!> ../../docs_src/header_params/tutorial002_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="10"
{!> ../../docs_src/header_params/tutorial002.py!}
```
////
{* ../../docs_src/header_params/tutorial002_an_py310.py hl[10] *}
/// warning
@ -214,71 +64,7 @@ You will receive all the values from the duplicate header as a Python `list`.
For example, to declare a header of `X-Token` that can appear more than once, you can write:
//// tab | Python 3.10+
```Python hl_lines="9"
{!> ../../docs_src/header_params/tutorial003_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="9"
{!> ../../docs_src/header_params/tutorial003_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="10"
{!> ../../docs_src/header_params/tutorial003_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="7"
{!> ../../docs_src/header_params/tutorial003_py310.py!}
```
////
//// tab | Python 3.9+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="9"
{!> ../../docs_src/header_params/tutorial003_py39.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="9"
{!> ../../docs_src/header_params/tutorial003.py!}
```
////
{* ../../docs_src/header_params/tutorial003_an_py310.py hl[9] *}
If you communicate with that *path operation* sending two HTTP headers like: