响应 - 更改状态码¶
你可能之前已经了解到,你可以设置默认的响应状态码。
但在某些情况下,你需要返回一个不同于默认值的状态码。
使用场景¶
例如,假设你想默认返回一个HTTP状态码为“OK”200。
但如果数据不存在,你想创建它,并返回一个HTTP状态码为“CREATED”201。
但你仍然希望能够使用response_model过滤和转换你返回的数据。
对于这些情况,你可以使用一个Response参数。
使用Response 参数¶
你可以在你的路径操作函数中声明一个Response类型的参数(就像你可以为cookies和头部做的那样)。
然后你可以在这个临时响应对象中设置status_code。
fromfastapiimportFastAPI,Response,statusapp=FastAPI()tasks={"foo":"Listen to the Bar Fighters"}@app.put("/get-or-create-task/{task_id}",status_code=200)defget_or_create_task(task_id:str,response:Response):iftask_idnotintasks:tasks[task_id]="This didn't exist before"response.status_code=status.HTTP_201_CREATEDreturntasks[task_id]然后你可以像平常一样返回任何你需要的对象(例如一个dict或者一个数据库模型)。
如果你声明了一个response_model,它仍然会被用来过滤和转换你返回的对象。
FastAPI将使用这个临时响应来提取状态码(也包括cookies和头部),并将它们放入包含你返回的值的最终响应中,该响应由任何response_model过滤。
你也可以在依赖项中声明Response参数,并在其中设置状态码。但请注意,最后设置的状态码将会生效。







