跳到内容

响应 Cookie

使用 Response 参数

你可以在路径操作函数中声明一个类型为 Response 的参数。

然后,你就可以在该临时响应对象中设置 Cookie。

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(以及请求头和状态码),并将它们放入包含你所返回值的最终响应中,同时还会根据任何 response_model 进行过滤。

你还可以在依赖项中声明 Response 参数,并在其中设置 Cookie(和请求头)。

直接返回 Response

你也可以在代码中直接返回 Response 时创建 Cookie。

为此,你可以按照 直接返回响应 中所述的方式创建响应。

然后在其上设置 Cookie,并将其返回。

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 过滤掉的数据。

更多信息

技术细节

你也可以使用 from starlette.responses import Responsefrom starlette.responses import JSONResponse

FastAPI 提供与 fastapi.responses 相同的 starlette.responses 只是为了方便开发者。但大多数可用的响应直接来自 Starlette。

由于 Response 经常被用于设置请求头和 Cookie,FastAPI 也在 fastapi.Response 中提供了它。

要查看所有可用的参数和选项,请查阅 Starlette 文档