FastAPI学习-12. 请求Cookie 参数

前言

你可以像定义 Query 参数和 Path 参数一样来定义 Cookie 参数。

声明 Cookie 参数

首先，导入 Cookie:

from fastapi import Cookie, FastAPI

声明 Cookie 参数的结构与声明 Query 参数和 Path 参数时相同。

第一个值是参数的默认值，同时也可以传递所有验证参数或注释参数，来校验参数：

from typing import Union

from fastapi import Cookie, FastAPI
from typing_extensions import Annotated

app = FastAPI()


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

在读取客户端中Cookie时需要注意，代码中cookie的变量名称必须和客户端cookie中的key值一致！！！

使用示例

@app.get("/demo")  
async def demo(  
        name: Union[str, None] = Cookie()  
):  
    print(f"name : {name}")  
    return {  
        "message": "Hello demo!",  
        "data": {"name": name}  
    }

Cookie 、Path 、Query是兄弟类，它们都继承自公共的 Param 类

但请记住，当你从 fastapi 导入的 Query、Path、Cookie 或其他参数声明函数，这些实际上是返回特殊类的函数。

你需要使用 Cookie 来声明 cookie 参数，否则参数将会被解释为查询参数。

总结

使用 Cookie 声明 cookie 参数，使用方式与 Query 和 Path 类似。