FastAPI教程 Cookie 參數(shù)

你可以像定義 Query 參數(shù)和 Path 參數(shù)一樣來定義 Cookie 參數(shù)。

導入 Cookie

首先，導入 Cookie:

from typing import Optional

from fastapi import Cookie, FastAPI

app = FastAPI()


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

聲明 Cookie 參數(shù)

聲明 Cookie 參數(shù)的結構與聲明 Query 參數(shù)和 Path 參數(shù)時相同。

第一個值是參數(shù)的默認值，同時也可以傳遞所有驗證參數(shù)或注釋參數(shù)，來校驗參數(shù)：

from typing import Optional

from fastapi import Cookie, FastAPI

app = FastAPI()


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

技術細節(jié)
Cookie 、Path 、Query是兄弟類，它們都繼承自公共的 Param 類
但請記住，當你從 fastapi 導入的 Query、Path、Cookie 或其他參數(shù)聲明函數(shù)，這些實際上是返回特殊類的函數(shù)。

Info
你需要使用 Cookie 來聲明 cookie 參數(shù)，否則參數(shù)將會被解釋為查詢參數(shù)。

總結

使用 Cookie 聲明 cookie 參數(shù)，使用方式與 Query 和 Path 類似。