跳到内容

响应头

使用 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 时,也可以添加响应头。

按照 直接返回 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 提供与 fastapi.responses 相同的 starlette.responses 只是为了方便开发者。但大多数可用的响应直接来自 Starlette。

由于 Response 经常被用于设置响应头和 cookie,FastAPI 也将其提供在 fastapi.Response 中。

自定义头

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

但如果你有希望让浏览器客户端看到的自定义头,则需要将它们添加到 CORS 配置中(阅读 CORS(跨源资源共享)了解更多),并使用 Starlette 的 CORS 文档中记录的 expose_headers 参数。