FastAPI学习-20.response 参数-设置响应头部

前言

你可以在你的_路径操作函数_中声明一个Response类型的参数。

设置响应头部

你可以在这个_临时_响应对象中设置头部

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时添加头部。

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中提供了它。