跳到内容

响应 - 更改状态码

您之前可能读到过,可以设置默认的 响应状态码

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

使用场景

例如,假设您希望默认返回 HTTP 状态码 "OK" 200

但如果数据不存在,您希望创建它,并返回 HTTP 状态码 "CREATED" 201

同时,您仍然希望能够使用 response_model 对返回的数据进行过滤和转换。

对于这些情况,您可以使用 Response 参数。

使用 Response 参数

您可以在路径操作函数中声明一个类型为 Response 的参数(就像对 cookie 和 header 所做的那样)。

然后,您可以在该临时响应对象中设置 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 将使用该临时响应来提取状态码(以及 cookie 和 header),并将它们放入包含您返回值的最终响应中,该返回值会由任何 response_model 进行过滤。

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