FastAPI（52）- Response Cookies 响应设置 Cookies
FastAPI（52）- Response Cookies 响应设置 Cookies
小菠萝测试笔记
发布于 2021-10-09 11:20:52
发布于 2021-10-09 11:20:52
前言
- 前面讲过如何获取 Cookies：https://cloud.tencent.com/developer/article/1883191
- 也顺带提了下如何设置 Response Cookie，还是比较简单的
有两种实现场景
- 路径操作函数声明 Response 参数来设置 Cookie
- 在函数内，通过 return Response 来设置 Cookie
路径操作函数声明 Response 参数来设置 Cookie
from fastapi import FastAPI, Response
app = FastAPI()
@app.get("/item")
# 路径操作函数声明一个 Response 类型的参数
async def get_item(response: Response):
response.set_cookie("test_token", "tokenABC")
return {"name": "设置Cookie"}- 然后可以像往常一样返回需要的任何对象（字典、数据库模型等）
- 如果声明了一个 response_model，它仍将用于过滤和转换返回的对象
- FastAPI 将使用该临时响应来提取 cookie（还有 headers、status_code），并将它们放入包含返回值的最终响应中，由任何 response_model 过滤
- 还可以在依赖项中声明 Response 参数，并在其中设置 cookie、headers
请求结果
再看看 Application
设置 Cookie 成功啦
声明 response_model 和使用依赖项的栗子
from fastapi import FastAPI, Response, Depends
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
id: str
name: str
async def depnds_set_cookie(response: Response):
response.set_cookie("x-depends-token", "************")
@app.get("/item2", dependencies=[Depends(depnds_set_cookie)], response_model=Item)
async def get_item():
return {"id": "12345", "name": "测试 dependencies和response_model", "age": 24}请求结果
通过 return Response 来设置 Cookie
from fastapi import FastAPI, Response
from fastapi.responses import JSONResponse
app = FastAPI()
@app.get("/items")
async def get_item():
response = JSONResponse(content={"name": "JSONResponse"})
response.set_cookie("test_token", "ABC_token")
return response请求结果
set_cookie 的源码
它是 Starlette 库的 Response 类里面的方法哦
参数详解
参数 | 作用 |
|---|---|
key | cookie 的键，str |
value | cookie 的值，str |
max_age | cookie 的生命周期，以秒为单位，int 负数或0表示立即丢弃该 cookie |
expires | cookie 的过期时间，以秒为单位，int |
path | cookie 种在哪个路径之下，默认根路径，str |
domain | cookie 有效的域，str |
secure | 如果使用 SSL 和 HTTPS 协议发出请求，cookie 只会发送到服务器，bool |
httponly | 无法通过 JS 的 Document.cookie、XMLHttpRequest 或请求 API 访问 cookie，bool |
samesite | 为 cookie 指定相同站点策略，str 有效值：“lax”（默认）、“strict”和“none” |
- cookie 的生命周期，以秒为单位，int
- 负数或0表示立即丢弃该 cookie
expires cookie 的过期时间，以秒为单位，int path cookie 种在哪个路径之下，默认根路径，str domain cookie 有效的域，str secure 如果使用 SSL 和 HTTPS 协议发出请求，cookie 只会发送到服务器，bool httponly 无法通过 JS 的 Document.cookie、XMLHttpRequest 或请求 API 访问 cookie，bool samesite - 为 cookie 指定相同站点策略，str
- 有效值：“lax”（默认）、“strict”和“none”
本文参与 腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。
原始发表：2021-10-04 ，如有侵权请联系 cloudcommunity@tencent.com 删除
目录
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号