字段格式化的意思就是对api接口返回的响应做出规范。
具体的思想是,先定义一个格式化输出样板fields
,然后在类视图中的视图方法上加marshal_with
装饰器使得格式化生效。这样做的有什么特别的用处吗?特性:
-
显示出我们设计的数据结构
-
默认返回的数据如果不在预定义的结构
fields
中,数据会被自动过滤 -
如果返回的数据在预定义结构
fields
中存在,数据才会正常返回 -
如果返回的数据字段比预定义结构
fields
中定义的字段要少,那么缺少的字段会呈现出一个默认值
一、定义字段输出格式
使用字典来进行定义,一般API接口的返回结果都是一个JSON对象。通常使用的数据类型是:String、Integer。使用字段格式化必须要导入from flask_restful import fields
from flask_restful import fields
# 格式化字段
user_fields = {
'msg': fields.String,
'status': fields.Integer,
'data': fields.String(attribute='private_data'),
'default_data': fields.String(default='1')
}