mirror/fastapi
1
0
Fork 0
mirror of https://github.com/fastapi/fastapi.git synced 2026-05-05 22:26:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

📝 Add docs about params as functions for mypy (#231)

Browse Source
This commit is contained in:
Sebastián Ramírez
2019-05-15 22:01:23 +04:00
committed by GitHub
parent ca27317b65
commit d240421378
7 changed files with 29 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/tutorial/header-params.md
View File

@@ -18,9 +18,11 @@ The first value is the default value, you can pass all the extra validation or a
{!./src/header_params/tutorial001.py!}
```
!!! info
!!! note "Technical Details"
`Header` is a "sister" class of `Path`, `Query` and `Cookie`. It also inherits from the same common `Param` class.
But remember that when you import `Query`, `Path`, `Header`, and others from `fastapi`, <a href="https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#recap" target="_blank">those are actually functions that return classes of the same name</a>.
!!! info
To declare headers, you need to use `Header`, because otherwise the parameters would be interpreted as query parameters.