Flask 构建统一响应格式：提升 API 开发效率与可维护性

安岁_

已于 2025-04-22 14:45:48 修改

阅读量972

点赞数 22

分类专栏： Python FLASK 文章标签： flask python 后端

于 2025-04-22 14:44:30 首次发布

本文链接：https://blog.csdn.net/m0_58530495/article/details/147421511

版权

引言

在当今的 Web 开发中，RESTful API 已成为前后端交互的主流方式。为了让前端能更高效地处理后端返回的数据，确保接口的一致性和可维护性，采用统一的响应格式至关重要。本文将深入探讨如何使用 Flask 框架来构建统一的响应格式，包括代码实现、设计逻辑、生产环境优化及常见问题解答。

一、统一响应函数的代码实现

基础响应函数

from flask import jsonify

def success_response(data=None, message="Success", code=200):
    """
    成功响应封装
    :param data: 响应数据（如数据库查询结果）
    :param message: 用户提示消息（默认："Success"）
    :param code: HTTP 状态码（默认：200）
    :return: Flask 响应元组 (JSON, status_code)
    """
    response_data = {
   "code": code, "message": message}
    if data is not None:
        response_data["data"] = data
    return jsonify(response_data), code

def error_response(message=