Cookie Parameters
You can define Cookie parameters the same way you define Query
and Path
parameters.
Import Cookie
First import Cookie
:
from fastapi import Cookie, FastAPI app = FastAPI() @app.get("/items/") async def read_items(*, ads_id: str = Cookie(None)): return {"ads_id": ads_id}
Declare Cookie
parameters
Then declare the cookie parameters using the same structure as with Path
and Query
.
The first value is the default value, you can pass all the extra validation or annotation parameters:
from fastapi import Cookie, FastAPI app = FastAPI() @app.get("/items/") async def read_items(*, ads_id: str = Cookie(None)): return {"ads_id": ads_id}
Info
Cookie
is a "sister" class of Path
and Query
. It also inherits from the same common Param
class.
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
.