Django REST Framework: ModelSerializer'a ek alan ekleme

Bir modeli serileştirmek istiyorum, ancak serileştirilecek model örneğinde bazı veritabanı aramaları yapmayı gerektiren ek bir alan eklemek istiyorum:

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

Bunu yapmanın doğru yolu nedir? Ben serileştiriciye ekstra "bağlam" geçebilirsiniz görüyorum, bir bağlam sözlüğünde ek alana geçmek için doğru cevap mı? Bu yaklaşımla, ihtiyacım olan alanı elde etme mantığı, serileştirilmiş her örneğin ihtiyaç duyacağı için ideal olan serileştirici tanımı ile kendi kendine yetmez my_field. DRF serileştiricileri belgelerinde başka yerlerde "fazladan alanlar herhangi bir özelliğe karşılık gelebilir veya modelde çağrılabilir" yazıyor . Fazladan bahsettiğim alanlar mı? FooModel tanımında my_fielddeğer döndüren bir işlev tanımlamalı mıyım ve serileştiricide my_field'ı bu çağrılabilire bağladım mı? Bu neye benziyor?

Şimdiden teşekkürler, gerekirse soruyu açıklığa kavuşturmaktan mutluluk duyarız.

SerializerMethodField aradığınız şey olduğunu düşünüyorum:

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

Model yönteminizi özelliğe değiştirebilir ve bu yaklaşımla seri hale getiricide kullanabilirsiniz.

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',)

Düzenleme: dinlenme çerçevesi (3.3.3 denedim) son sürümleri ile, özellik değiştirmek gerekmez. Model yöntemi iyi çalışır.

Django Rest Framework'ün son sürümünde, modelinizde eklemek istediğiniz alanın adıyla bir yöntem oluşturmanız gerekir. Bir hataya gerek yok @propertyve source='field'bir hata yükseltmek.

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

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

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

Benzer bir soruya ( burada ) yanıt vermem yararlı olabilir.

Aşağıdaki şekilde tanımlanmış bir Model Yönteminiz varsa:

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

Bahsedilen yöntemi çağırmanın sonucunu serileştiricinize şu şekilde ekleyebilirsiniz:

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

ps Özel alan gerçekten modelinizdeki bir alan olmadığından, genellikle aşağıdaki gibi salt okunur yapmak istersiniz:

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

fazladan alanınızda okumak ve yazmak istiyorsanız, serileştiricileri genişleten yeni bir özel serileştirici kullanabilirsiniz.

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']

Bu bazı özel mantık ile ilgili iç içe alanlarda kullanın

Bu benim için çalıştı . Sadece içine ek bir alan eklemek istiyorsakModelSerializer, bunu aşağıdaki gibi yapabiliriz ve ayrıca bazı arama hesaplamalarından sonra alana bazı val atanabilir. Veya bazı durumlarda, parametreleri API yanıtında göndermek istiyorsak.

Model.py içinde

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

Serializer.py içinde

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 ')

Umarım bu birine yardımcı olabilir.

As Kimya Programer söyledi Bu yoruma , DRF son içinde aynen bu şekilde yapabilirsiniz:

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 dokümanları kaynağı