2.3 KiB
Cookie Parameters
You can define Cookie parameters the same way you define Query and Path parameters.
Import Cookie
First import Cookie:
//// tab | Python 3.10+
{!> ../../docs_src/cookie_params/tutorial001_an_py310.py!}
////
//// tab | Python 3.9+
{!> ../../docs_src/cookie_params/tutorial001_an_py39.py!}
////
//// tab | Python 3.8+
{!> ../../docs_src/cookie_params/tutorial001_an.py!}
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the Annotated version if possible.
///
{!> ../../docs_src/cookie_params/tutorial001_py310.py!}
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the Annotated version if possible.
///
{!> ../../docs_src/cookie_params/tutorial001.py!}
////
Declare Cookie parameters
Then declare the cookie parameters using the same structure as with Path and Query.
You can define the default value as well as all the extra validation or annotation parameters:
//// tab | Python 3.10+
{!> ../../docs_src/cookie_params/tutorial001_an_py310.py!}
////
//// tab | Python 3.9+
{!> ../../docs_src/cookie_params/tutorial001_an_py39.py!}
////
//// tab | Python 3.8+
{!> ../../docs_src/cookie_params/tutorial001_an.py!}
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the Annotated version if possible.
///
{!> ../../docs_src/cookie_params/tutorial001_py310.py!}
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the Annotated version if possible.
///
{!> ../../docs_src/cookie_params/tutorial001.py!}
////
/// note | "Technical Details"
Cookie is a "sister" class of Path and Query. It also inherits from the same common Param class.
But remember that when you import Query, Path, Cookie and others from fastapi, those are actually functions that return special classes.
///
/// info
To declare cookies, you need to use Cookie, because otherwise the parameters would be interpreted as query parameters.
///
Recap
Declare cookies with Cookie, using the same common pattern as Query and Path.