FastAPI 基础学习(十四) Response自定义状态码
作者:麦克煎蛋 出处:https://www.cnblogs.com/mazhiyong/ 转载请保留这段声明,谢谢!
一、通过参数status_code自定义状态码
我们可以用参数status_code
来声明Response状态码。
支持任意路径操作:
@app.get()
@app.post()
@app.put()
@app.delete()
from fastapi import FastAPI app = FastAPI() @app.post("/items/", status_code=201) async def create_item(name: str): return {"name": name}
参数
status_code
接收一个数字内容,作为HTTP状态码。并且会在response中返回这个状态码,同时会在文档中记录。
注意
status_code
是装饰器方法(get,post等)的参数。
我们可以从 fastapi.status
导入状态码常量,便于使用和记忆。
from fastapi import FastAPI, status app = FastAPI() @app.post("/items/", status_code=status.HTTP_201_CREATED) async def create_item(name: str): return {"name": name}
二、通过Response参数
自定义状态码
我们可以在路径操作函数中声明Response
参数,然后给这个临时的Response
对象设置status_code
信息。
FastAPI通过这个临时的Response
对象解析出status_code
信息(以及header、cookie信息等),然后放入到最终返回的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]
三、通过直接返回Response
自定义状态码
FastAPI默认情况下会通过JSONResponse
返回请求结果,返回的状态码是默认状态码或者是路径操作中设置的状态码。
如果我们想自定义状态码,可以通过直接返回Response对象来设置状态码,比如直接返回JSONResponse
对象。
如下示例,我们需要先导入JSONResponse
,然后自定义状态码,直接返回数据对象。
from typing import Optional from fastapi import Body, FastAPI, status from fastapi.responses import JSONResponse app = FastAPI() items = {"foo": {"name": "Fighters", "size": 6}, "bar": {"name": "Tenders", "size": 3}} @app.put("/items/{item_id}") async def upsert_item(item_id: str, name: Optional[str] = Body(None), size: Optional[int] = Body(None)): if item_id in items: item = items[item_id] item["name"] = name item["size"] = size return item else: item = {"name": name, "size": size} items[item_id] = item return JSONResponse(status_code=status.HTTP_201_CREATED, content=item)
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析
· 没有源码,如何修改代码逻辑?
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· 在鹅厂做java开发是什么体验
· 百万级群聊的设计实践
· WPF到Web的无缝过渡:英雄联盟客户端的OpenSilver迁移实战
· 永远不要相信用户的输入:从 SQL 注入攻防看输入验证的重要性
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析