Django REST Framework: adding additional field to ModelSerializer Django REST Framework: adding additional field to ModelSerializer django django

Django REST Framework: adding additional field to ModelSerializer


I think SerializerMethodField is what you're looking for:

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


You can change your model method to property and use it in serializer with this approach.

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

Edit: With recent versions of rest framework (I tried 3.3.3), you don't need to change to property. Model method will just work fine.


With the last version of Django Rest Framework, you need to create a method in your model with the name of the field you want to add. No need for @property and source='field' raise an error.

class Foo(models.Model):    . . .    def foo(self):        return 'stuff'    . . .class FooSerializer(ModelSerializer):    foo = serializers.ReadOnlyField()    class Meta:        model = Foo        fields = ('foo',)