响应 - 更改状态码¶
你可能之前读到过,你可以设置默认的响应状态码。
但在某些情况下,你需要返回一个不同于默认状态码的状态码。
使用场景¶
例如,假设你希望默认返回一个“OK”的HTTP状态码200
。
但如果数据不存在,你希望创建它,并返回一个“CREATED”的HTTP状态码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
参数,并在其中设置状态码。但请记住,最后设置的那个将胜出。