官方文档:Cookie 参数 - FastAPI
Cookie 参数¶
定义 Cookie
参数与定义 Query
和 Path
参数一样。
源码:
from typing import Annotated
from fastapi import Cookie, FastAPI
app = FastAPI()
@app.get("/items/")
async def read_items(ads_id: Annotated[str | None, Cookie()] = None):
return {"ads_id": ads_id}
导入 Cookie
¶
首先,导入 Cookie
:
from fastapi import Cookie, FastAPI
声明 Cookie
参数¶
声明 Cookie
参数的方式与声明 Query
和 Path
参数相同。第一个值是默认值,还可以传递所有验证参数或注释参数:
async def read_items(ads_id: Annotated[str | None, Cookie()] = None):
"技术细节"
Cookie
、Path
、Query
是兄弟类,都继承自共用的Param
类。注意,从
fastapi
导入的Query
、Path
、Cookie
等对象,实际上是返回特殊类的函数。
"说明"
必须使用
Cookie
声明 cookie 参数,否则该参数会被解释为查询参数。
小结¶
使用 Cookie
声明 cookie 参数的方式与 Query
和 Path
相同。
Cookie参数模型
如果你有一组相关的Cookie,你可以创建一个Pydantic模型来声明它们。