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}
🤓 其他版本和变体
from typing import Annotated, Union
from fastapi import Cookie, FastAPI
app = FastAPI()
@app.get("/items/")
async def read_items(ads_id: Annotated[Union[str, None], Cookie()] = None):
return {"ads_id": ads_id}
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}
提示
如果可能，请优先使用 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}
提示
如果可能，请优先使用 Annotated 版本。
from typing import Union
from fastapi import Cookie, FastAPI
app = FastAPI()
@app.get("/items/")
async def read_items(ads_id: Union[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}
🤓 其他版本和变体
from typing import Annotated, Union
from fastapi import Cookie, FastAPI
app = FastAPI()
@app.get("/items/")
async def read_items(ads_id: Annotated[Union[str, None], Cookie()] = None):
return {"ads_id": ads_id}
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}
提示
如果可能，请优先使用 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}
提示
如果可能，请优先使用 Annotated 版本。
from typing import Union
from fastapi import Cookie, FastAPI
app = FastAPI()
@app.get("/items/")
async def read_items(ads_id: Union[str, None] = Cookie(default=None)):
return {"ads_id": ads_id}
技术细节
Cookie 是 Path 和 Query 的“姊妹”类。它也继承自相同的通用 Param 类。
但请记住，当你从 fastapi 导入 Query、Path、Cookie 及其他时，它们实际上是返回特殊类的函数。
信息
要声明 cookies，你需要使用 Cookie，因为否则参数将被解释为查询参数。
信息
请记住，由于浏览器以特殊方式在后台处理 cookies，它们不容易允许 JavaScript 接触它们。
如果你访问 /docs 处的 API 文档 UI，你将能够看到你的路径操作的 cookies 文档。
但是，即使你填写数据并点击“执行”，由于文档 UI 使用 JavaScript，cookies 将不会被发送，你将看到一个错误消息，就好像你没有写入任何值一样。
总结¶
使用 Cookie 声明 cookies，采用与 Query 和 Path 相同的通用模式。