Back to Fastapi

Cookie 參數 { #cookie-parameters }

docs/zh-hant/docs/tutorial/cookie-params.md

0.139.01.5 KB
Original Source

Cookie 參數 { #cookie-parameters }

你可以用與定義 QueryPath 參數相同的方式定義 Cookie 參數。

先匯入 Cookie

{* ../../docs_src/cookie_params/tutorial001_an_py310.py hl[3] *}

然後用與 PathQuery 相同的結構宣告 Cookie 參數。

你可以設定預設值,以及所有額外的驗證或註解參數:

{* ../../docs_src/cookie_params/tutorial001_an_py310.py hl[9] *}

/// note | 技術細節

CookiePathQuery 的「姊妹」類別。它同樣繼承自共同的 Param 類別。

但請記住,當你從 fastapi 匯入 QueryPathCookie 等時,它們實際上是回傳特殊類別的函式。

///

/// note

要宣告 cookies,你需要使用 Cookie,否則參數會被當作查詢參數(query parameters)來解析。

///

/// note

請注意,由於瀏覽器會以特殊方式並在背後處理 cookies,因此容易讓 JavaScript 觸碰到它們。

如果你前往位於 /docsAPI 文件介面,你可以在你的*路徑操作(path operations)*中看到 cookies 的文件

但即使你填入資料並點擊「Execute」,由於該文件介面是以 JavaScript 運作,cookies 不會被送出,你會看到一則錯誤訊息,就好像你沒有填任何值一樣。

///

總結 { #recap }

使用 Cookie 來宣告 cookies,遵循與 QueryPath 相同的通用寫法。