Cookie 参数¶
你可以像定义 Query 和 Path 参数一样定义 Cookie 参数。
导入 Cookie¶
首先导入 Cookie
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}
🤓 其他版本和变体
提示
如果可能，请优先使用 Annotated 版本。
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}
声明 Cookie 参数¶
然后使用与 Path 和 Query 相同的结构声明 cookie 参数。
你可以定义默认值，以及所有额外的验证或注解参数。
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}
🤓 其他版本和变体
提示
如果可能，请优先使用 Annotated 版本。
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}
技术细节
Cookie 是 Path 和 Query 的“姊妹”类。它也继承自相同的通用 Param 类。
但请记住，当你从 fastapi 导入 Query、Path、Cookie 等时，它们实际上是返回特殊类的函数。
注意
要声明 cookie，你需要使用 Cookie，否则参数会被解释为查询参数。
注意
请注意，由于浏览器处理 cookie 的方式非常特殊且在后台运行，它们并不轻易允许 JavaScript 访问这些 cookie。
如果你访问 /docs 处的 API 文档 UI，你将能够看到你的路径操作对应的 cookie 文档。
但即使你填写了数据并点击“Execute”，由于文档 UI 是通过 JavaScript 运行的，cookie 不会被发送，你会看到一条错误消息，就像你没有填写任何值一样。
回顾¶
使用 Cookie 声明 cookie，并遵循与 Query 和 Path 相同的通用模式。