FASTAPI系列 17-设置响应参数Cookies

FASTAPI系列 17-设置响应参数Cookies

---

---

前言

可以在路径函数中定义一个类型为Response的参数，这样你就可以在这个临时响应对象中设置cookie了。

---

一、response 参数

设置cookies

from fastapi import FastAPI, Response

app = FastAPI()


@app.post("/create_cookie/")
def create_cookie(response: Response):
    response.set_cookie(key="userSessionId ", value="A3fH9qT1KmXZrLpYBcGJUw")
    return {"message": "创建了一个cookie"}

还可以根据你的需要响应不同的对象，比如常用的 dict，数据库model等。如果定义了response_model，程序会自动根据response_model来过滤和转换你响应的对象。FastAPI 会使用这个临时响应对象去装在这些cookies信息 (同样还有headers和状态码等信息), 最终会将这些信息和通过response_model转化过的数据合并到最终的响应里。你也可以在depend中定义Response参数，并设置cookie和header。

二、直接响应 Response

还可以在直接响应Response时直接创建cookies。然后设置Cookies，并返回；

@app.post("/cookie/")
def create_cookie():
    content = {"message": "创建了一个cookie"}
    response = JSONResponse(content=content)
    response.set_cookie(key="userSessionId", value="A3fH9qT1KmXZrLpYBcGJUw")
    return response

---

总结

需要注意，如果你直接反馈一个response对象，而不是使用Response入参，FastAPI则会直接反馈你封装的response对象。所以你需要确保你响应数据类型的正确性，如：你可以使用JSONResponse来兼容JSON的场景。同时，你也应当仅反馈通过response_model过滤过的数据。