响应头

使用 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 Response 或 from starlette.responses import JSONResponse。

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

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

自定义头信息

请记住，自定义的专有头信息可以通过 使用 'X-' 前缀 来添加。

但如果你有自定义头信息，并且希望浏览器中的客户端能够看到它们，你需要将它们添加到你的 CORS 配置中（更多信息请阅读 CORS（跨源资源共享）），使用 Starlette 的 CORS 文档 中记录的 expose_headers 参数。