回應 Cookie¶

🌐 AI 與人類共同完成的翻譯

此翻譯由人類指導的 AI 完成。🤝

可能會有對原意的誤解，或讀起來不自然等問題。🤖

你可以透過協助我們更好地引導 AI LLM來改進此翻譯。

英文版

使用 `Response` 參數¶

你可以在路徑操作函式（path operation function）中宣告一個型別為 Response 的參數。

接著你可以在那個「暫時」的 Response 物件上設定 Cookie。

Python 3.10+

from fastapi import FastAPI, Response

app = FastAPI()


@app.post("/cookie-and-object/")
def create_cookie(response: Response):
    response.set_cookie(key="fakesession", value="fake-cookie-session-value")
    return {"message": "Come to the dark side, we have cookies"}

之後如常回傳你需要的任何物件（例如 dict、資料庫模型等）。

如果你宣告了 response_model，它仍會用來過濾並轉換你回傳的物件。

FastAPI 會使用那個暫時的 Response 取出 Cookie（以及標頭與狀態碼），並將它們放入最終回應；最終回應包含你回傳的值，且會套用任何 response_model 的過濾。

你也可以在相依項（dependencies）中宣告 Response 參數，並在其中設定 Cookie（與標頭）。

直接回傳 `Response`¶

當你在程式碼中直接回傳 Response 時，也可以建立 Cookie。

要這麼做，你可以依照直接回傳 Response 中的說明建立一個回應。

接著在其中設定 Cookie，然後回傳它：

Python 3.10+

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()


@app.post("/cookie/")
def create_cookie():
    content = {"message": "Come to the dark side, we have cookies"}
    response = JSONResponse(content=content)
    response.set_cookie(key="fakesession", value="fake-cookie-session-value")
    return response

提示

請注意，如果你不是使用 Response 參數，而是直接回傳一個 Response，FastAPI 會原樣回傳它。

因此你必須確保資料型別正確；例如，如果你回傳的是 JSONResponse，就要確保資料可與 JSON 相容。

同時也要確認沒有送出原本應該由 response_model 過濾的資料。

回應 Cookie¶

使用 Response 參數¶

直接回傳 Response¶

更多資訊¶

使用 `Response` 參數¶

直接回傳 `Response`¶