FastAPI学习-19.response 参数-修改状态码

前言

假设你想默认返回一个HTTP状态码为“OK”200。
但如果数据不存在，你想创建它，并返回一个HTTP状态码为“CREATED”201。

但你仍然希望能够使用response_model过滤和转换你返回的数据。
对于这些情况，你可以使用一个response`参数。

使用 response 参数

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和头部)，并将它们放入包含你返回的值的最终响应中，该响应由任何response_model过滤。

返回Response 对象

也可以直接返回 Respouse 对象

from fastapi import Response, status  
  
  
tasks = {"foo": "Listen to the Bar Fighters"}  
  
  
@app.put("/task/{task_id}", status_code=200)  
def get_or_create_task(task_id: str):  
    if task_id == '2':  
        return Response('{"msg": "ok"}', status_code=202, media_type='application/json')  
    return tasks[task_id]

测试

PUT http://127.0.0.1:8000/task/2 HTTP/1.1
User-Agent: Fiddler
Host: 127.0.0.1:8000
Content-Type: application/json
Content-Length: 0


HTTP/1.1 202 Accepted
date: Sun, 17 Sep 2023 02:11:46 GMT
server: uvicorn
content-length: 13
content-type: application/json

{"msg": "ok"}