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

Изменить: В последних версиях остальные рамки (я попробовал 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, мы можем сделать это, как показано ниже, а также поле может быть присвоено некоторое значение val после некоторых вычислений поиска. Или в некоторых случаях, если мы хотим отправить параметры в ответ 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 ')

Надеюсь, это может кому-то помочь.

Как сказал Chemical Programer в этом комментарии , в последнем 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 документация источник