17

フラスコの安静拡張について質問があります。私はそれを使い始めたばかりで、1つの問題に直面しました。多対 1 の関係に接続されているエンティティがあり、マーシャラーを使用flask-sqlalchemyして安らかなエンドポイントがすべての子を持つ親エンティティを返すようにします。json私の場合、 Set には多くのパラメーターが含まれています。フラスコ安静ドキュメントを見ましたが、このケースを解決する方法についての説明はありませんでした。

明らかな何かが欠けているようですが、解決策がわかりません。これが私のコードです：

# 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

したがって、エンドポイントが次の json を返す set_marshaller を正しく定義する方法が必要です。

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

助けていただければ幸いです。

4

2 に答える 2

26

私は自分でその問題の解決策を見つけました。

遊んだ後flask-restful、私はいくつかの間違いを犯したことがわかりました：

まずset_marshaller、次のようになります。

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

パラメーターがリストであり、リストにマーシャリングする場合、落ち着きのないマーシャラーは大文字と小文字を処理できますjson。

もう 1 つの問題は、API Set パラメータで遅延読み込みが発生することでした。そのため、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")
于 2014-02-27T08:37:16.300 に答える
9

これはジギマンタスの答えへの追加です：

私は Flask-RESTful を使用しています。これは、ネストされたプロパティの読み込みに対する解決策です。

呼び出し可能オブジェクトをマーシャル デコレータに渡すことができます。

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) group 引数を使用して、どのように表現をカスタマイズできるか。ここには「フラット」しかありませんが、任意のロジックを記述して、より深くネストされたオブジェクトに渡すことができます。

3) エンティティは必要に応じてのみ読み込まれます。

于 2015-12-16T11:17:52.617 に答える