跳转至

响应头

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