3

概述

我正在使用 Flask-SqlAlchemy,现在我正在研究棉花糖来帮助我序列化和反序列化请求数据。

我能够成功:

  1. 使用Flask-SqlAlchemy创建我的模型

  2. 通过使用可选的 Flask-SqlAlchemy 集成,使用Flask-Marshmallow使用相同的模型序列化数据库对象

  3. 使用marshmallow-jsonapi快速生成符合 Json API 的响应。这需要我声明新的 Schema以指定我想要包含的属性(这与 Flask-SqlAlchemy 模型重复)

代码示例

Flask-SqlAlchemy 声明式模型

class Space(db.Model):

    __tablename__ = 'spaces'
    id = sql.Column(sql.Integer, primary_key=True)
    name = sql.Column(sql.String)
    version = sql.Column(sql.String)
    active = sql.Column(sql.Boolean)

flask_marshmallow 模式声明(继承自 SqlAlchemy 模型)

ma = flask_marshmallow.Marshmallow(app)

class SpaceSchema(ma.ModelSchema):
    class Meta:
        model = Space

# API Response
space = Space.query.first()
return SpaceSchema().dump(space).data

# Returns:
{
'id': 123,
'version': '0.1.0',
'name': 'SpaceName',
'active': True
}

marshmallow_json api - 需要新的模式声明,必须包含每个属性和手动类型

class SpaceJsonSchema(marshmallow_json.Schema):
    id = fields.Str(dump_only=True)
    name = fields.Str()
    version = fields.Str()
    active = fields.Bool()

    class Meta:
        type_ = 'spaces'
        self_url = '/spaces/{id}'
        self_url_kwargs = {'id': '<id>'}
        self_url_many = '/spaces/'
        strict = True

# Returns Json API Compliant
{
    'data': {
        'id': '1',
        'type': 'spaces',
        'attributes': {
            'name': 'Phonebooth',
            'active': True,
            'version': '0.1.0'
         },
        'links': {'self': '/spaces/1'}
    },
    'links': {'self': '/spaces/1'}
}

问题

如代码所示,marshmallow-jsonapi允许我创建符合 json api 的响应,但我最终不得不维护一个声明模型 + 模式响应模型。

flask-marshmallow允许我从 SqlAlchemy 模型创建 Schema 响应,因此我不必为每个模型维护一组单独的属性。


问题

是否可以一起使用flask-marshmallowmarshmallow-jsonapi 1. 从 SqlAlchemy 模型创建 Marshmallow Schema,自动生成 json api 响应?

ma.ModelSchema我尝试在两个命令中创建从and继承的 Schema 声明marshmallow_json.Schema,但它不起作用(引发缺少方法和属性的异常)


棉花糖-jsonapi

marshmallow-jsonapi 提供了一种在任何 Python Web 框架中生成符合 JSON API 的数据的简单方法。

烧瓶棉花糖

Flask-Marshmallow 包含用于与 Flask-SQLAlchemy 和 marshmallow-sqlalchemy 集成的有用附加功能。

4

1 回答 1

0

不是这个确切问题的解决方案,但我在实现这个库时遇到了类似的问题:https ://github.com/thomaxxl/safrs (sqlalchemy + flask-restful + jsonapi compliant spec)。我不记得我是如何解决它的,但是如果您尝试它并且序列化不起作用,如果您在 github 中打开问题,我可以帮助您解决它

于 2018-02-04T11:18:01.080 回答