响应 Cookies¶

🌐 由 AI 与人类协作翻译

本翻译由人类引导的 AI 生成。🤝

可能存在误解原意或不够自然等问题。🤖

你可以通过帮助我们更好地引导 AI LLM来改进此翻译。

英文版本

使用 `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 会使用这个临时响应来提取 Cookie（还有 header 和状态码），并将它们放入最终响应中；最终响应包含你返回的值，并经过任何 response_model 过滤。

你也可以在依赖项中声明 Response 参数，并在其中设置 Cookie（和 header）。

直接返回 `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 参数，FastAPI 会直接返回它。

因此，你必须确保你的数据类型正确。例如，如果你返回的是 JSONResponse，数据就需要兼容 JSON。

并且还要确保你没有发送本应由 response_model 过滤的数据。

响应 Cookies¶

使用 Response 参数¶

直接返回 Response¶

更多信息¶

使用 `Response` 参数¶

直接返回 `Response`¶