Response Cookies¶
使用 Response 参数¶
您可以在路径操作函数中声明一个类型为 Response 的参数。
然后您可以在该临时响应对象中设置 cookies。
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 将使用该临时响应来提取 cookies（以及 headers 和 status code），并将它们放入包含您返回值的最终响应中，该响应会经过任何 response_model 的过滤。
您也可以在依赖项中声明 Response 参数，并在其中设置 cookies（和 headers）。
直接返回 Response¶
您也可以在代码中直接返回 Response 时创建 cookies。
要做到这一点，您可以按照直接返回 Response 中的描述创建一个响应。
然后在其中设置 Cookies，并返回它：
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
Tip
请注意，如果您直接返回响应而不是使用 Response 参数，FastAPI 将直接返回它。
因此，您必须确保您的数据类型正确。例如，如果您返回 JSONResponse，则要确保数据与 JSON 兼容。
并且还要确保您没有发送任何本应被 response_model 过滤的数据。
更多信息¶
技术细节
您也可以使用 from starlette.responses import Response 或 from starlette.responses import JSONResponse。
FastAPI 提供与 starlette.responses 相同的 fastapi.responses，只是为了方便开发者。但大多数可用的响应直接来自 Starlette。
并且由于 Response 可能经常用于设置 headers 和 cookies，FastAPI 也在 fastapi.Response 中提供了它。
要查看所有可用的参数和选项，请查看 Starlette 中的文档。