ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

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

2022-01-06 12:31:51  阅读:150  来源: 互联网

标签:return Headers FastAPI 53 Response headers Header response


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

 

前言

 

有两种实现场景

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

 

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

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 和使用依赖项的栗子

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

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 了

 

 

标签:return,Headers,FastAPI,53,Response,headers,Header,response
来源: https://www.cnblogs.com/xiao-xue-di/p/15770555.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有