跳到内容

响应头

使用 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 参数。