Flask-restful:将复杂对象编组为json

Question

我有一个关于flask restful扩展的问题。我刚刚开始使用它，面临着一个问题。我有连接多对一关系的flask-sqlalchemy实体，我希望restful端点使用编组程序在json中返回父实体及其所有子实体。在我的例子中，Set包含许多参数。我查看了flask-restful docs，但是没有任何关于如何解决这个问题的解释。

似乎我遗漏了一些显而易见的东西，但又找不到任何解决方案。下面是我的代码：

# entities
class Set(db.Model):
    id = db.Column("id", db.Integer, db.Sequence("set_id_seq"), primary_key=True)
    title = db.Column("title", db.String(256))

    parameters = db.relationship("Parameters", backref="set", cascade="all")


class Parameters(db.Model):
    id = db.Column("id", db.Integer, db.Sequence("parameter_id_seq"), primary_key=True)
    flag = db.Column("flag", db.String(256))
    value = db.Column("value", db.String(256))
    set_id = db.Column("set_id", db.Integer, db.ForeignKey("set.id"))


# marshallers

from flask.ext.restful import fields

parameter_marshaller = {
    "flag": fields.String,
    "value": fields.String
}

set_marshaller = {
    'id': fields.String,
    'title': fields.String,
    'parameters': fields.List(fields.Nested(parameter_marshaller))
}

# endpoint    

class SetApi(Resource):

    @marshal_with(marshallers.set_marshaller)
    def get(self, set_id):
        entity = Set.query.get(set_id)
        return entity


restful_api = Api(app)
restful_api.add_resource(SetApi, "/api/set/<int:set_id>")

现在，当我调用/api/set/1时，我得到了服务器错误：

TypeError: 'Set' object is unsubscriptable

所以我需要一种方法来正确定义set_marshaller端点返回这个json：

{
  "id": : "1",
  "title": "any-title",
  "parameters": [
       {"flag": "any-flag", "value": "any-value" },
       {"flag": "any-flag", "value": "any-value" },
       .....
   ]
}

我很感谢你的帮助。

Answer 1

我自己找到了那个问题的解决方案。

在使用flask-restful之后，我发现我犯了几个错误：

首先，set_marshaller应该是这样的：

set_marshaller = {
    'id': fields.String,
    'title': fields.String,
    'parameters': fields.Nested(parameter_marshaller)
}

如果参数是list并封送到json list，则不停用的封送程序可以处理这种情况。

另一个问题是，在API参数有延迟加载，所以当我尝试封送Set时，我得到了KeyError: 'parameters'，所以我需要像这样显式加载参数：

class SetApi(Resource):

     @marshal_with(marshallers.set_marshaller)
     def get(self, set_id):
        entity = Set.query.get(set_id)
        entity.parameters # loads parameters from db
        return entity

或者，另一个选项是更改模型关系：

parameters = db.relationship("Parameters", backref="set", cascade="all" lazy="joined")

Answer 2

这是对的的一个补充

我正在使用Flask-RESTful，这是加载嵌套属性的一种解决方案。

您可以将一个callable传递给marshal装饰器：

class OrgsController(Resource):
    @marshal_with(Organization.__json__())
    def get(self):
        return g.user.member.orgs

然后更新模型以返回其自身实体的资源字段。因此，嵌套实体将相对地返回其实体的资源字段。

class Organization(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    ...

    @staticmethod
    def __json__(group=None):
        _json = {
            'id': fields.String,
            'login': fields.String,
            'description': fields.String,
            'avatar_url': fields.String,
            'paid': fields.Boolean,
        }

        if group == 'flat':
            return _json

        from app.models import Repository
        _json['repos'] = fields.Nested(Repository.__json__('flat'))

        return _json

class Repository(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    owner_id = db.Column(db.Integer, db.ForeignKey('organization.id'))
    owner = db.relationship('Organization', lazy='select', backref=db.backref('repos', lazy='select'), foreign_keys=[owner_id])
    ...

    @staticmethod
    def __json__(group=None):
        _json = {
            'id': fields.String,
            'name': fields.String,
            'updated_at': fields.DateTime(dt_format='iso8601'),
        }

        if group == 'flat':
            return _json

        from app.models import Organization
        _json['owner'] = fields.Nested(Organization.__json__('flat'))

        return _json

这给出了我正在寻找的表示，并遵守延迟加载：

[
    {
        "avatar_url": "https://avatars.githubusercontent.com/u/18945?v=3",
        "description": "lorem ipsum.",
        "id": "1805",
        "login": "foobar",
        "paid": false,
        "repos":
            [
                {
                    "id": "9813",
                    "name": "barbaz",
                    "updated_at": "2014-01-23T13:51:30"
                },
                {
                    "id": "12860",
                    "name": "bazbar",
                    "updated_at": "2015-04-17T11:06:36"
                }
            ]
    }
]

我喜欢

1)这种方法如何允许我为每个实体定义我的资源字段，并且它对我在应用程序中的所有资源路由都是可用的。

2)组参数如何允许我随心所欲地定制表示。我在这里只有“平面”，但任何逻辑都可以编写并向下传递到更深的嵌套对象。

3)仅在必要时加载实体。