如何在Python的Flask中统一格式化REST API返回结构-Python教程-PHP中文网

必须用装饰器或中间件统一响应格式，避免在每个视图中重复手写jsonify；需结合after_request钩子（加json类型判断）和自定义@api_response装饰器（支持success/error分支、状态码透传、异常捕获），并配合errorhandler全局接管werkzeug及自定义异常，确保code分层、msg语义明确、字段可扩展。

如何在python的flask中统一格式化rest api返回结构

统一返回结构必须用装饰器或中间件，别在每个视图里手写

Flask 本身不强制返回格式，硬编码 jsonify({"code": 0, "data": ..., "msg": "ok"}) 在几十个路由里重复出现，后期改字段名或加时间戳会疯掉。真正可维护的做法是拦截响应，而不是拼字典。

推荐用 after_request 钩子统一处理，但要注意：它对所有响应生效（包括静态文件、404 页面），所以得先判断是否为 JSON API 响应：

检查 response.headers.get("Content-Type", "").startswith("application/json")
或更稳妥地——只处理你明确标记的视图，比如用自定义装饰器打标：@api_response
避免在 after_request 里直接修改 response.data 字节流，容易破坏编码；应解析成 dict 再重组

用自定义装饰器最灵活，支持 success/error 分支和状态码透传

比全局钩子更可控，还能让每个接口决定是否启用、是否覆盖默认 code/msg。典型实现是包装视图函数返回值：

python全能编程助手

SkillSub Pro - Python 题解与代码注释双功能技能功能概述SkillSub Pro - Python 题解与代码注释双功能技能是一项面向实际任务的技能，主要用于SkillSub Pro 是一个 Python 题解生成与代码注释的双功能合体技能，专为学生、算法学习者和开发者设计；✅ 一个技能，两种用途：；核心要点📝 题解模式：输入题目/题号，自动生成完整 Python 题解（含详细注释、解题思路、复杂度分析）；💬 注释模式：输入 Python 代码，自动添加详细中。它将相关步骤、

下载

@app.route("/user")
@api_response
def get_user():
    return {"id": 123, "name": "Alice"}  # 自动包成 {"code": 0, "data": {...}, "msg": "ok"}

装饰器内部用 isinstance(return_value, dict) 判断是否为业务数据，不是则原样透传（比如返回 Response 对象或字符串）
显式支持错误抛出：raise ApiException(400, "参数错误")，由装饰器捕获并转为标准错误结构
保留原始 HTTP 状态码：若视图返回 jsonify({...}), 401，装饰器需提取状态码，不能一律设 200
别把时间戳、请求 ID 这类字段写死在装饰器里——通过参数控制开关，比如 @api_response(include_timestamp=True)

错误统一处理必须覆盖 Werkzeug 异常和自定义异常

404、405 这类 Werkzeug 默认异常不会进你的视图，也不会被 @api_response 拦到。必须用 register_error_handler 单独接管：

app.register_error_handler(404, lambda e: jsonify({"code": 404, "msg": "接口不存在", "data": None}))
app.register_error_handler(ApiException, lambda e: jsonify({"code": e.code, "msg": e.msg, "data": None}), 200)

Werkzeug 异常（如 NotFound）默认返回 HTML，要强制转 JSON，且状态码保持原样（404 就是 404）
自定义异常（如 ApiException）建议继承 Exception 而非 HTTPException，否则会被 Flask 当作标准 HTTP 错误提前处理
不要在错误处理器里再调用 jsonify 包一层嵌套——jsonify 返回的是 Response 对象，直接返回即可
注意 500 错误：开发时要显示 traceback，生产环境必须屏蔽，只返回泛化提示