跳到内容

响应 - 更改状态码

你可能之前已经读到过,可以设置一个默认的响应状态码

但在某些情况下,你需要返回一个与默认值不同的状态码。

用例

例如,假设你想默认返回一个 HTTP 状态码 "OK" 200

但如果数据不存在,你想创建它,并返回一个 HTTP 状态码 "CREATED" 201

但你仍然希望能够使用 response_model 来过滤和转换你返回的数据。

对于这些情况,你可以使用一个 Response 参数。

使用 Response 参数

你可以在你的*路径操作函数*中声明一个类型为 Response 的参数(就像你可以对 cookies 和 headers 做的那样)。

然后你可以在那个*临时*的响应对象中设置 status_code

from fastapi import FastAPI, Response, status

app = FastAPI()

tasks = {"foo": "Listen to the Bar Fighters"}


@app.put("/get-or-create-task/{task_id}", status_code=200)
def get_or_create_task(task_id: str, response: Response):
    if task_id not in tasks:
        tasks[task_id] = "This didn't exist before"
        response.status_code = status.HTTP_201_CREATED
    return tasks[task_id]

然后你可以像往常一样返回任何你需要的对象(一个 dict、一个数据库模型等)。

如果你声明了一个 response_model,它仍然会被用来过滤和转换你返回的对象。

FastAPI 将会使用那个*临时*的响应来提取状态码(也包括 cookies 和 headers),并将它们放入包含你返回的值的最终响应中,该值会由任何 response_model 进行过滤。

你也可以在依赖项中声明 Response 参数,并在其中设置状态码。但请记住,最后设置的那个会生效。