跳转至

响应头信息

使用 Response 参数

您可以在路径操作函数中声明一个类型为 Response 的参数(就像处理 cookies 时一样)。

然后您可以在该临时响应对象中设置头信息。

from fastapi import FastAPI, Response

app = FastAPI()


@app.get("/headers-and-object/")
def get_headers(response: Response):
    response.headers["X-Cat-Dog"] = "alone in the world"
    return {"message": "Hello World"}

之后您可以像平常一样返回任何需要的对象(如 dict、数据库模型等)。

如果您声明了 response_model,它仍将用于过滤和转换您返回的对象。

FastAPI 将使用该临时响应来提取头信息(以及 cookies 和状态码),并将它们放入最终的响应中,该响应包含您返回的值,并经过任何 response_model 的过滤。

您也可以在依赖项中声明 Response 参数,并在其中设置头信息(和 cookies)。

直接返回 Response

您也可以在直接返回 Response 时添加头信息。

按照直接返回响应中的说明创建响应,并将头信息作为附加参数传入:

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()


@app.get("/headers/")
def get_headers():
    content = {"message": "Hello World"}
    headers = {"X-Cat-Dog": "alone in the world", "Content-Language": "en-US"}
    return JSONResponse(content=content, headers=headers)

技术细节

您也可以使用 from starlette.responses import Responsefrom starlette.responses import JSONResponse

FastAPI 提供与 starlette.responses 相同的 fastapi.responses,这只是为了方便开发者您。但大部分可用的响应直接来自 Starlette。

由于 Response 常用于设置头信息和 cookies,FastAPI 也在 fastapi.Response 中提供了它。

自定义头信息

请注意,自定义专有头信息可以使用 'X-' 前缀添加。

但如果您有希望浏览器客户端能够看到的自定义头信息,您需要将它们添加到 CORS 配置中(详见 CORS (跨源资源共享)),使用 Starlette 的 CORS 文档中记录的 expose_headers 参数。