Django REST Framework：ModelSerializerにフィールドを追加する

モデルをシリアル化したいが、シリアル化するモデルインスタンスでいくつかのデータベースルックアップを実行する必要がある追加のフィールドを含めたい：

class FooSerializer(serializers.ModelSerializer):
  my_field = ... # result of some database queries on the input Foo object
  class Meta:
        model = Foo
        fields = ('id', 'name', 'myfield')

これを行う正しい方法は何ですか？余分な「コンテキスト」をシリアライザに渡すことができると思いますが、コンテキストディクショナリの追加フィールドを渡す正しい答えは何ですか。そのアプローチでは、必要なフィールドを取得するロジックはシリアライザ定義で自己完結することはなく、すべてのシリアル化されたインスタンスがを必要とするため理想的ですmy_field。他の場所でDRFシリアライザのドキュメントでそれは言う、「追加のフィールドは、モデル上の任意のプロパティまたは呼び出し可能に対応させることができます」。余分なフィールドは私が話していることですか？Fooのモデル定義でmy_field値を返す関数を定義し、シリアライザでmy_fieldをその呼び出し可能オブジェクトにフックする必要がありますか？それはどのように見えますか？

よろしくお願いします。必要に応じて、質問を明確にします。

SerializerMethodFieldはあなたが探しているものだと思います：

class FooSerializer(serializers.ModelSerializer):
  my_field = serializers.SerializerMethodField('is_named_bar')

  def is_named_bar(self, foo):
      return foo.name == "bar" 

  class Meta:
    model = Foo
    fields = ('id', 'name', 'my_field')

http://www.django-rest-framework.org/api-guide/fields/#serializermethodfield

モデルのメソッドをプロパティに変更して、このアプローチでシリアライザーで使用できます。

class Foo(models.Model):
    . . .
    @property
    def my_field(self):
        return stuff
    . . .

class FooSerializer(ModelSerializer):
    my_field = serializers.ReadOnlyField(source='my_field')

    class Meta:
        model = Foo
        fields = ('my_field',)

編集：最近のバージョンのRESTフレームワーク（3.3.3を試しました）では、プロパティを変更する必要はありません。モデルメソッドはうまくいきます。

Django Rest Frameworkの最新バージョンでは、追加するフィールドの名前を使用してモデルにメソッドを作成する必要があります。必要はありません@propertyし、source='field'エラーを発生させます。

class Foo(models.Model):
    . . .
    def foo(self):
        return 'stuff'
    . . .

class FooSerializer(ModelSerializer):
    foo = serializers.ReadOnlyField()

    class Meta:
        model = Foo
        fields = ('foo',)

同様の質問（ここ）に対する私の回答が役に立つかもしれません。

次の方法で定義されたモデルメソッドがある場合：

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

上記のメソッドを呼び出した結果をシリアライザに次のように追加できます。

class MyModelSerializer(serializers.ModelSerializer):
    model_method_field = serializers.CharField(source='model_method')

psカスタムフィールドは実際にはモデル内のフィールドではないため、通常は次のように読み取り専用にする必要があります。

class Meta:
    model = MyModel
    read_only_fields = (
        'model_method_field',
        )

追加のフィールドで読み書きしたい場合は、serializers.Serializerを拡張した新しいカスタムシリアライザーを使用して、次のように使用できます。

class ExtraFieldSerializer(serializers.Serializer):
    def to_representation(self, instance): 
        # this would have the same as body as in a SerializerMethodField
        return 'my logic here'

    def to_internal_value(self, data):
        # This must return a dictionary that will be used to
        # update the caller's validation data, i.e. if the result
        # produced should just be set back into the field that this
        # serializer is set to, return the following:
        return {
          self.field_name: 'Any python object made with data: %s' % data
        }

class MyModelSerializer(serializers.ModelSerializer):
    my_extra_field = ExtraFieldSerializer(source='*')

    class Meta:
        model = MyModel
        fields = ['id', 'my_extra_field']

私はいくつかのカスタムロジックで関連するネストされたフィールドでこれを使用します

これは私にとってうまく いきました.ModelSerializerにフィールドを追加するだけの場合は、以下のように行うことができます。また、ルックアップの計算後にフィールドに値を割り当てることができます。または、APIレスポンスでパラメータを送信する場合。

model.py

class Foo(models.Model):
    """Model Foo"""
    name = models.CharField(max_length=30, help_text="Customer Name")



   **

serializer.py

**

class FooSerializer(serializers.ModelSerializer):
    retrieved_time = serializers.SerializerMethodField()

    @classmethod
    def get_retrieved_time(self, object):
        """getter method to add field retrieved_time"""
        return None

  class Meta:
        model = Foo
        fields = ('id', 'name', 'retrieved_time ')

**

これが誰かを助けることを願っています

**

化学プログラマはで言ったこのコメント、DRF最新であなたはちょうどこのようにそれを行うことができます。

class FooSerializer(serializers.ModelSerializer):
    extra_field = serializers.SerializerMethodField()

    def get_extra_field(self, foo_instance):
        return foo_instance.a + foo_instance.b

    class Meta:
        model = Foo
        fields = ('extra_field', ...)

DRFドキュメントソース