🍪 Как установить куки fastapi: подробная инструкция для начинающих

Чтобы установить куки в FastAPI, вы можете использовать модуль "starlette", на котором основан FastAPI. Ниже приведен пример кода:

from fastapi import FastAPI
from starlette.responses import Response

app = FastAPI()

@app.get("/")
def read_root(response: Response):
    response.set_cookie(key="cookie_name", value="cookie_value")

Как установить куки в FastAPI

FastAPI — это мощный фреймворк для создания веб-приложений с использованием языка программирования Python. В этой статье мы рассмотрим, как установить и использовать куки (cookies) в FastAPI.

Что такое куки?

Куки — это механизм хранения информации на стороне клиента. Они позволяют веб-серверу сохранять информацию на компьютере пользователя и использовать ее при последующих запросах.

Установка куки в FastAPI

Для установки куки в FastAPI мы можем использовать объект Response и его метод set_cookie. Для демонстрации давайте предположим, что у нас есть простой маршрут /set-cookie, который устанавливает куку с именем "my_cookie" и значением "Hello, World!".

from fastapi import FastAPI, Response

app = FastAPI()

@app.get("/set-cookie")
async def set_cookie(response: Response):
    response.set_cookie(key="my_cookie", value="Hello, World!")
    return {"message": "Cookie has been set!"}
    

Когда наш сервер обрабатывает GET-запрос на /set-cookie, мы используем метод set_cookie объекта response для установки куки. Здесь мы указываем имя куки ("my_cookie") и его значение ("Hello, World!").

Чтение куки из запроса

Чтобы получить значение куки из запроса в FastAPI, мы можем использовать объект Request и его атрибут cookies. Ниже приведен пример кода, демонстрирующий чтение значения куки с именем "my_cookie" из запроса.

from fastapi import FastAPI, Request

app = FastAPI()

@app.get("/get-cookie")
async def get_cookie(request: Request):
    my_cookie = request.cookies.get("my_cookie")
    return {"message": f"The value of my_cookie is: {my_cookie}"}
    

Когда мы обрабатываем GET-запрос на /get-cookie, мы используем атрибут cookies объекта request для получения значения куки с именем "my_cookie". Затем мы возвращаем сообщение с полученным значением куки.

Удаление куки

В FastAPI мы можем удалить куки, устанавливая ее с истекшим сроком годности. Ниже приведен пример кода, демонстрирующий удаление куки с именем "my_cookie".

from fastapi import FastAPI, Response

app = FastAPI()

@app.get("/delete-cookie")
async def delete_cookie(response: Response):
    response.delete_cookie(key="my_cookie")
    return {"message": "Cookie has been deleted!"}
    

Когда мы обрабатываем GET-запрос на /delete-cookie, мы используем метод delete_cookie объекта response для удаления куки с именем "my_cookie".

Защита куки

Важно учитывать безопасность при использовании куки. FastAPI предоставляет функциональность для защиты куки с помощью подписей и шифрования. Это позволяет предотвратить подмену значений куки и обеспечить их конфиденциальность.

Чтобы использовать защиту куки в FastAPI, мы должны настроить секретный ключ (secret key) и, возможно, другие параметры безопасности. Пример использования защищенной куки выходит за рамки этой статьи, но вы можете изучить документацию FastAPI, чтобы узнать больше об этой функциональности.

Заключение

В этой статье мы рассмотрели, как установить и использовать куки в FastAPI. Мы познакомились с методами set_cookie и delete_cookie объекта Response, а также с атрибутом cookies объекта Request. Также была упомянута важность защиты куки для обеспечения безопасности.