Flask 学习-57.Flask-RESTX 定制返回统一的JSON格式

最新推荐文章于 2025-03-17 17:25:16 发布

上海-悠悠

最新推荐文章于 2025-03-17 17:25:16 发布

阅读量923

点赞数

分类专栏： Python flask 文章标签： flask python 学习

本文链接：https://blog.youkuaiyun.com/qq_27371025/article/details/126748026

版权

flask 同时被 2 个专栏收录

105 篇文章 ¥29.90 ¥99.00

订阅专栏

超级会员免费看

Python

283 篇文章

订阅专栏

本文介绍了如何在Flask-RESTX框架中定制统一的JSON返回格式，通过Api对象的representation装饰器实现接口返回数据的格式化。示例代码展示了如何定义并应用自定义的output_json方法，确保所有接口返回符合预设的{'code': 0, 'message': 'success', 'data': {}}格式。" 132485248,19671473,R语言控制小数位数：format()与sprintf()函数,"['R语言', '开发语言']

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

一般在接口开发中，会定制统一的返回JSON 格式如：{‘code’: 0, ‘message’: ‘success’, ‘data’: {}}

定制JSON 格式

Flask-RESTX 的Api对象提供了一个representation的装饰器，允许定制返回数据的呈现格式

基本示例

api = Api(app)
 
@api.representation('application/json')
def output_json(data, code, headers):
    # TODO ..... 添加自定义处理
    return resp

在flask_restful.representations.py文件源码中有一个output_json 方法

def output_json(data, code, headers=None):
    """Makes a Flask response with a JSON encoded body"""

    settings = current_app.config.get("RESTX_JSON", {})

    # If we're in debug mode, and the indent is not set, we set it to a
    # reasona

了解本专栏

超级会员免费看