跳转至

Response - 更改状态码

你可能之前已经了解到可以设置默认的 响应状态码

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

使用场景

例如,假设你希望默认返回 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 参数,并在其中设置状态码。但请记住,最后设置的值将生效。