首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >FastAPI(53)- Response Headers 响应设置 Headers

FastAPI(53)- Response Headers 响应设置 Headers

作者头像
小菠萝测试笔记
发布于 2021-10-09 10:49:19
发布于 2021-10-09 10:49:19
1.6K0
举报

前言

有两种实现场景

  • 路径操作函数声明 Response 参数来设置 Header
  • 在函数内,通过 return Response 来设置 Header

路径操作函数声明 Response 参数来设置 Header

代码语言:javascript
复制
from fastapi import FastAPI, Response

app = FastAPI()


@app.get("/item")
# 路径操作函数声明一个 Response 类型的参数
async def get_item(response: Response):
    response.headers["x-token"] = "token_!@#%#$^$%&"
    return {"name": "设置 headers"}
  • 然后可以像往常一样返回需要的任何对象(字典、数据库模型等)
  • 如果声明了一个 response_model,它仍将用于过滤和转换返回的对象
  • FastAPI 将使用该临时响应来提取 headers(还有 cookies、status_code),并将它们放入包含返回值的最终响应中,由任何 response_model 过滤
  • 还可以在依赖项中声明 Response 参数,并在其中设置 headers、cookies
请求结果
声明 response_model 和使用依赖项的栗子
代码语言:javascript
复制
from fastapi import FastAPI, Response, Depends
from pydantic import BaseModel

app = FastAPI()
class Item(BaseModel):
    id: str
    name: str


async def depnds_header(response: Response):
    response.headers["x-depends-token"] = "************"


@app.get("/item2", dependencies=[Depends(depnds_header)], response_model=Item)
async def get_item():
    return {"id": "12345", "name": "测试 dependencies和response_model", "age": 24}
请求结果
​

通过 return Response 来设置 Header

代码语言:javascript
复制
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.headers["x-auth-token"] = "XXX_TOKEN"
    return response
请求结果

headers 的源码

它是 Starlette 库的 Response 类里面的方法哦,加了 @property 变成属性,就可以访问私有属性 _headers 了

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2021-10-04 ,如有侵权请联系 cloudcommunity@tencent.com 删除
目录
  • 前言
  • 有两种实现场景
  • 路径操作函数声明 Response 参数来设置 Header
    • 请求结果
    • 声明 response_model 和使用依赖项的栗子
    • 请求结果
    • ​
  • 通过 return Response 来设置 Header
    • 请求结果
  • headers 的源码
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档