Skip to content

От переводчика

Это машинный перевод (DeepSeek) статьи https://fastapi.tiangolo.com/tutorial/cookie-param-models/

Версия от 03.09.2026

Неочевидных моментов в уроке не обнаружено, но я рад сообщить, что дополнил базу инструмента для импорта модулей и классов в python классами, использующимися в уроке.

Подпишитесь на канал "Изучаем FastAPI", чтобы ссылки на инструмент работала.

 

Перевод прочих разделов документации буду по мере сил делать.

Обо мне

Модели параметров Cookie

Если у вас есть группа связанных cookies, вы можете создать модель Pydantic, чтобы объявить их. 🍪

Это позволит вам повторно использовать модель в нескольких местах, а также объявлять валидации и метаданные для всех параметров сразу. 😎

Примечание

Это поддерживается начиная с версии FastAPI 0.115.0. 🤓

Совет

Эта же техника применима к Query, Cookie и Header. 😎

Cookies с моделью Pydantic

Объявите параметры cookie, которые вам нужны, в модели Pydantic, а затем объявите параметр как Cookie:

from typing import Annotated

from fastapi import Cookie, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Cookies(BaseModel):
    session_id: str
    fatebook_tracker: str | None = None
    googall_tracker: str | None = None


@app.get("/items/")
async def read_items(cookies: Annotated[Cookies, Cookie()]):
    return cookies
🤓 Другие версии и варианты

Совет

По возможности предпочитайте версию с Annotated.

from fastapi import Cookie, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Cookies(BaseModel):
    session_id: str
    fatebook_tracker: str | None = None
    googall_tracker: str | None = None


@app.get("/items/")
async def read_items(cookies: Cookies = Cookie()):
    return cookies

FastAPI извлечёт данные для каждого поля из cookies, полученных в запросе, и передаст вам определённую вами модель Pydantic.

Проверьте документацию

Вы можете увидеть определённые cookies в интерфейсе документации по адресу /docs:

Примечание

Имейте в виду, что, поскольку браузеры обрабатывают cookies особым образом и за кулисами, они не легко позволяют JavaScript касаться их.

Если вы перейдёте в интерфейс документации API по адресу /docs, вы сможете увидеть документацию для cookies для ваших операций пути.

Но даже если вы заполните данные и нажмёте «Execute», поскольку интерфейс документации работает на JavaScript, cookies не будут отправлены, и вы увидите сообщение об ошибке, как будто вы не вводили никаких значений.

Запрет дополнительных cookies

В некоторых особых случаях использования (вероятно, не очень распространённых) вы можете захотеть ограничить cookies, которые вы хотите получать.

Теперь ваш API имеет возможность контролировать собственное согласие на cookie. 🤪🍪

Вы можете использовать конфигурацию модели Pydantic, чтобы forbid (запретить) любые extra (дополнительные) поля:

from typing import Annotated

from fastapi import Cookie, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Cookies(BaseModel):
    model_config = {"extra": "forbid"}

    session_id: str
    fatebook_tracker: str | None = None
    googall_tracker: str | None = None


@app.get("/items/")
async def read_items(cookies: Annotated[Cookies, Cookie()]):
    return cookies
🤓 Другие версии и варианты

Совет

По возможности предпочитайте версию с Annotated.

from fastapi import Cookie, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Cookies(BaseModel):
    model_config = {"extra": "forbid"}

    session_id: str
    fatebook_tracker: str | None = None
    googall_tracker: str | None = None


@app.get("/items/")
async def read_items(cookies: Cookies = Cookie()):
    return cookies

Если клиент попытается отправить какие-либо дополнительные cookies, он получит ответ с ошибкой.

Бедные баннеры cookie со всеми их усилиями получить ваше согласие на то, чтобы API отклонил его. 🍪

Например, если клиент попытается отправить cookie santa_tracker со значением good-list-please, клиент получит ответ с ошибкой, сообщающий, что santa_tracker cookie не разрешён:

{
    "detail": [
        {
            "type": "extra_forbidden",
            "loc": ["cookie", "santa_tracker"],
            "msg": "Extra inputs are not permitted",
            "input": "good-list-please",
        }
    ]
}

Итог

Вы можете использовать модели Pydantic для объявления cookies в FastAPI. 😎