响应头

使用 Response 参数

您可以在您的路径操作函数中声明一个类型为 Response 的参数（就像您对 cookie 所做的那样）。

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

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 将使用该临时响应来提取头部（以及 cookie 和状态码），并将它们放入包含您返回的值的最终响应中，并根据任何 response_model 进行过滤。

您也可以在依赖项中声明 Response 参数，并在其中设置头部（和 cookie）。

直接返回 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 Response 或 from starlette.responses import JSONResponse。

FastAPI 提供与 fastapi.responses 相同的 starlette.responses，只是为了方便您，开发人员。但是大多数可用的响应都直接来自 Starlette。

并且由于 Response 可以经常用于设置头部和 cookie，因此 FastAPI 也将其提供在 fastapi.Response 中。

自定义头部

请记住，可以添加自定义专有头部使用 'X-' 前缀。

但是，如果您有希望浏览器中的客户端能够看到的自定义头部，则需要将它们添加到您的 CORS 配置中（在CORS（跨源资源共享） 中了解更多信息），使用参数 expose_headers，如Starlette 的 CORS 文档 中所述。