Flask-RESTful 输出字段

参考资料：https://flask-restful.readthedocs.io/en/latest/fields.html



Flask-RESTful 提供了一个简单的方式来控制在你的响应中实际呈现什么数据。使用 fields 模块，你可以使用在你的资源里的任意对象（ORM 模型、定制的类等）并且 fields 让你格式化和过滤响应，因此您不必担心暴露内部数据结构。



基本用法

你可以定义一个字典或者 fields 的 OrderedDict 类型，OrderedDict 类型是指键名是要呈现的对象的属性或键的名称，键值是一个类，该类格式化和返回的该字段的值。

这个例子有三个字段，两个是字符串（Strings）以及一个是日期时间（DateTime），格式为 RFC 822 日期字符串（同样也支持 ISO 8601）

from flask_restful import Resource, fields, marshal_with

resource_fields = {
    'name': fields.String,
    'address': fields.String,
    'date_updated': fields.DateTime(dt_format='rfc822'),
}

class Todo(Resource):
    @marshal_with(resource_fields, envelope='resource')
    def get(self, **kwargs):
        return db_get_todo()  # Some function that queries the db

这个例子假设你有一个自定义的数据库对象（todo），其属性为 name、address 和 date_updated。我们可以自己选择传递和读取哪些对象属性。

装饰器 marshal_with 指定按照哪个字典来读取参数，envelope 关键字设定了数据的包装后的命名。

下面演示一个完整例子：

todos = {'1': {'name': 'tom', 'address': '20th street '}}

resource_fields = {
    'name': fields.String,
    'address': fields.String,
}

class Todo(Resource):

    @marshal_with(resource_fields, envelope='resource')
    def get(self, id):
        # 这里实际操作中可写成用 ORM 模块获取对象实例的代码
        return todos[id]

api.add_resource(Todo, '/<string:id>')

以上代码定义的 API：http://127.0.0.1:5000/1，其结果是：

{"resource": {"name": "tom", "address": "20th street "}}

也可以不使用装饰器 marshal_with 而改用 marshal 方法：

from flask_restful import Resource, fields, marshal

todos = {'1': {'name': 'tom', 'address': '20th street '}}

resource_fields = {
    'name': fields.String,
    'address': fields.String,
}

class Todo(Resource):

    def get(self, id):
        # 这里实际操作中可写成用 ORM 模块获取对象实例的代码
        data = todos[id]
        return marshal(data, resource_fields, envelope='todo')

api.add_resource(Todo, '/<string:id>')

envelope 在这里是可选的参数，API 的结果：

{ "todo": {"name": "tom", "address": "20th street "}}



属性重命名

如果想在 API 展示的字段名和对象的属性名不一致，可使用 attribute 关键字来重命名。

todos = {'1': {'user_name': 'tom', 'address': '20th street '}}

resource_fields = {
    'name': fields.String(attribute='user_name'),
    'address': fields.String,
}

class Todo(Resource):

    @marshal_with(resource_fields, envelope='todos')
    def get(self, id):
        return todos[id]

api.add_resource(Todo, '/<string:id>')

以上代码定义的 API：http://127.0.0.1:5000/1，其结果是：

{"todos": {"address": "20th street ", "name": "tom"}}

attribute 关键字也可以使用 lambda 方法来定义更复杂的属性名。

fields = {
    'name': fields.String(attribute=lambda x: x._private_name),
    'address': fields.String,
}

嵌套属性的访问方法：

fields = {
    'name': fields.String(attribute='people_list.0.person_dictionary.name'),
    'address': fields.String,
}



默认值

如果对象实例某个属性不存在，会返回 null。

todos = {'1': {'name': 'tom', 'address': '20th street '}}

resource_fields = {
    'name': fields.String(),
    'address': fields.String,
    'age': fields.String,
}

class Todo(Resource):

    @marshal_with(resource_fields, envelope='todos')
    def get(self, id):
        return todos[id]

api.add_resource(Todo, '/<string:id>')

API 结果：

{"todos": {"address": "20th street ", "age": null, "name": "tom"}}

可以用 default 关键字来设置默认值来代替返回空值：

fields = {
    'name': fields.String(default='Anonymous User'),
    'address': fields.String,
}



字段格式化 / 自定义

当我们需要把对象实例的属性值格式化再输出时，可以继承 fields.Raw 类并且实现格式化函数。

todos = {'1': {
    'name': 'tom', 
    'address': '20th street',
    'age': 12
    }}

class FormatItem(fields.Raw):
    # 自定义格式化函数
    def format(self, value):
        return "adult" if value > 18 else "child"

resource_fields = {
    'name': fields.String,
    'address': fields.String,
    'generation': FormatItem(attribute='age'),
}

class Todo(Resource):

    @marshal_with(resource_fields, envelope='todos')
    def get(self, id):
        return todos[id]

api.add_resource(Todo, '/<string:id>')

API 结果：

{"todos": {"name": "tom", "generation": "child", "address": "20th street"}}



URL

Flask-RESTful 包括一个特殊的字段，field.Url，他根据其他 Resource 类的 endpoint 生成一个 URL。

user_fields = {
    'name': fields.String,
}

class User(Resource):
    @marshal_with(user_fields, envelope='user')
    def get(self):
        return {'name': 'tom'}
api.add_resource(User, '/user', endpoint='/user')


post_fields = {
    'content': fields.String,
    # todo_resource is the endpoint name when you called api.add_resource()
    'user': fields.Url('/user'),
}

class Post(Resource):
    @marshal_with(post_fields, envelope='post')
    def get(self):
        return {'content': '2333'}
api.add_resource(Post, '/post')

生成的 API http://127.0.0.1:5000/post 结果：

{
    "post": {
        "content": "2333",
        "user": "/user"
    }
}

下面我们使用 fields.Url 和 endpoint 来处理更复杂的情况，post 和 user 都要带上自己的 id：

users = {
    '1': {'name': 'tom'}
}

posts = {
    '1': {'content': '2333', 'author_id': '1'}
}


user_fields = {
    'name': fields.String,
}

class User(Resource):
    @marshal_with(user_fields, envelope='user')
    def get(self, user_id):
        user = users.get(user_id)
        return user
api.add_resource(User, '/user/<string:user_id>', endpoint='/user')


post_fields = {
    'content': fields.String,
    # 根据 Resource 类的 endpoint 来匹配
    'user': fields.Url('/user'),
}

class Post(Resource):
    @marshal_with(post_fields, envelope='post')
    def get(self, post_id):
        post = posts.get(post_id)
        post['user'] = users.get(post.get('author_id'))
        # 因为 user 的 url 设定了 user_id 参数，这里也要带上 user_id
        post['user_id'] = post.get('author_id')
        return post
api.add_resource(Post, '/post/<string:post_id>')

http://127.0.0.1:5000/post/1 的输出结果：

{
    "post": {
        "content": "2333",
        "user": "/user/1"
    }
}



列表字段

使用 fields.List 字段返回列表：

todos = {'1': {'name': 'tom', 'address': ['China', 'Beijing', 'ChaoYang']}}

resource_fields = {
    'name': fields.String,
    'address': fields.List(fields.String),
}

class Todo(Resource):
    @marshal_with(resource_fields, envelope='user')
    def get(self, id):
        # 这里实际操作中可写成用 ORM 模块获取对象实例的代码
        return todos[id]
api.add_resource(Todo, '/<string:id>')

结果：

{
    "user": {
        "name": "tom",
        "address": ["China", "Beijing",  "ChaoYang"]
    }
}



嵌套字段

如果 user 对象的一个属性 address 也是另一个对象， address 本身也有自己的属性，这时就需要用到嵌套字段，使用 fields.Nested 来设置。

users = {'1': {'name': 'tom', 'address_id': '1'}}
addresses = {'1': {'country': 'china', 'city': 'Beijing', 'district': 'ChaoYang'}}

address_fields = {
    'country' : fields.String,
    'city' : fields.String,
    'district' : fields.String,
}

user_fields = {
    'name': fields.String,
    'address': fields.Nested(address_fields),
}

class User(Resource):

    @marshal_with(user_fields, envelope='user')
    def get(self, id):
        # 这里实际操作中可写成用 ORM 模块获取对象实例的代码
        user = users[id]
        user['address'] = addresses[user.get('address_id')]
        return user

api.add_resource(User, '/<string:id>')

结果：

{
    "user": {
        "address": {
            "city": "Beijing",
            "district": "ChaoYang",
            "country": "china"
        },
        "name": "tom"
    }
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 214,444评论 6赞 496
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,421评论 3赞 389
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 160,036评论 0赞 349
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,363评论 1赞 288
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,460评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,502评论 1赞 292
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,511评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,280评论 0赞 270
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,736评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,014评论 2赞 328
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,190评论 1赞 342
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,848评论 5赞 338
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,531评论 3赞 322
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,159评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,411评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,067评论 2赞 365
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,078评论 2赞 352