从模型中获取 JSONAPI 模式

Question

在我的 Rest 应用程序中，我想像 JSONAPI 格式一样返回 json，但我需要为它创建 Schema 类并再次创建我的 model 中已经存在的每个字段。因此，我不能从 DB Model.. 中获取它，而不是在模式类中创建每个字段。 下面是我的模型类

class Author(db.Model):
  id = db.Column(db.Integer)
  name = db.Column(db.String(255))

我正在定义如下所示的架构。

class AuthorSchema(Schema):
    id = fields.Str(dump_only=True)
    name = fields.Str()
    metadata = fields.Meta()

    class Meta:
        type_ = 'people'
        strict = True

所以在这里，id 和 name 我已经定义了两次。 marshmallow-jsonapi 中是否有任何选项可以在架构类中分配模型名称，以便它可以从 model 获取所有字段
注意：我正在使用 marshmallow-jsonapifor 它，我已经尝试过 marshmallow-sqlalchemy ，它具有该选项但它不会以 JSONAPI 格式返回 json

Answer 1

您可以将flask-marshmallow 的ModelSchema 和marshmallow-sqlalchemy 与marshmallow-jsonapi 结合使用，但需要注意的是，您不仅要继承Schema 类，还要继承SchemaOpts 类，如下所示：

# ...
from flask_marshmallow import Marshmallow
from marshmallow_jsonapi import Schema, SchemaOpts
from marshmallow_sqlalchemy import ModelSchemaOpts


# ...

ma = Marshmallow(app)

# ...

class JSONAPIModelSchemaOpts(ModelSchemaOpts, SchemaOpts):
    pass


class AuthorSchema(ma.ModelSchema, Schema):
    OPTIONS_CLASS = JSONAPIModelSchemaOpts

    class Meta:
        type_ = 'people'
        strict = True
        model = Author

# ...
foo = AuthorSchema()
bar = foo.dump(query_results).data # This will be in JSONAPI format including every field in the model