Параметры Cookie

Вы можете задать параметры Cookie таким же способом, как Query и Path параметры.

Импорт Cookie

Сначала импортируйте Cookie:

Python 3.10+Python 3.8+

from fastapi import Cookie, FastAPI

app = FastAPI()


@app.get("/items/")
async def read_items(ads_id: str | None = Cookie(default=None)):
    return {"ads_id": ads_id}

from typing import Union

from fastapi import Cookie, FastAPI

app = FastAPI()


@app.get("/items/")
async def read_items(ads_id: Union[str, None] = Cookie(default=None)):
    return {"ads_id": ads_id}

Объявление параметров Cookie

Затем объявляйте параметры cookie, используя ту же структуру, что и с Path и Query.

Первое значение - это значение по умолчанию, вы можете передать все дополнительные параметры проверки или аннотации:

Python 3.10+Python 3.8+

from fastapi import Cookie, FastAPI

app = FastAPI()


@app.get("/items/")
async def read_items(ads_id: str | None = Cookie(default=None)):
    return {"ads_id": ads_id}

from typing import Union

from fastapi import Cookie, FastAPI

app = FastAPI()


@app.get("/items/")
async def read_items(ads_id: Union[str, None] = Cookie(default=None)):
    return {"ads_id": ads_id}

Технические детали

Cookie - это класс, родственный Path и Query. Он также наследуется от общего класса Param.

Но помните, что когда вы импортируете Query, Path, Cookie и другое из fastapi, это фактически функции, которые возвращают специальные классы.

Дополнительная информация

Для объявления cookies, вам нужно использовать Cookie, иначе параметры будут интерпретированы как параметры запроса.

Резюме

Объявляйте cookies с помощью Cookie, используя тот же общий шаблон, что и Query, и Path.