Django Rest framework, how to include ‘__all__’ fields and a related field in ModelSerializer ?

by

Like @DanEEStart said, DjangoRestFramework don’t have a simple way to extend the ‘all‘ value for fields, because the get_field_names methods seems to be designed to work that way.

But fortunately you can override this method to allow a simple way to include all fields and relations without enumerate a tons of fields.

I override this method like this:

class ToppingSerializer(serializers.ModelSerializer):

    class Meta:
        model = Topping
        fields="__all__"
        extra_fields = ['pizzas']

    def get_field_names(self, declared_fields, info):
        expanded_fields = super(ToppingSerializer, self).get_field_names(declared_fields, info)

        if getattr(self.Meta, 'extra_fields', None):
            return expanded_fields + self.Meta.extra_fields
        else:
            return expanded_fields

Note that this method only change the behaviour of this serializer, and the extra_fields attribute only works on this serializer class.

If you have a tons of serializer like this, you can create a intermediate class to include this get_fields_names method in one place and reuse’em many times. Some like this:

class CustomSerializer(serializers.HyperlinkedModelSerializer):

    def get_field_names(self, declared_fields, info):
        expanded_fields = super(CustomSerializer, self).get_field_names(declared_fields, info)

        if getattr(self.Meta, 'extra_fields', None):
            return expanded_fields + self.Meta.extra_fields
        else:
            return expanded_fields


class ToppingSerializer(CustomSerializer):

    class Meta:
        model = Topping
        fields="__all__"
        extra_fields = ['pizzas']

class AnotherSerializer(CustomSerializer):

    class Meta:
        model = Post
        fields="__all__"
        extra_fields = ['comments']

More Related Contents:

  1. “Post Image data using POSTMAN”
  2. How to register users in Django REST framework?
  3. When saving, how can you check if a field has changed?
  4. Django rest framework, use different serializers in the same ModelViewSet
  5. How to express a One-To-Many relationship in Django?
  6. Django – Circular model import issue
  7. Override default queryset in Django admin
  8. Setting the selected value on a Django forms.ChoiceField
  9. Django: Set foreign key using integer?
  10. Django ModelForm: What is save(commit=False) used for?
  11. How do you use the django-filter package with a list of parameters?
  12. Django Rest Framework with ChoiceField
  13. Django Rest Framework and JSONField
  14. django.db.migrations.exceptions.InconsistentMigrationHistory
  15. django – get() returned more than one topic
  16. Django custom managers – how do I return only objects created by the logged-in user?
  17. Django: Validate file type of uploaded file
  18. Django data migration when changing a field to ManyToMany
  19. CSRF Failed: CSRF token missing or incorrect
  20. Django accessing ManyToMany fields from post_save signal
  21. How do you filter a nested serializer in Django Rest Framework?
  22. Dropdown in Django Model
  23. how to show datepicker calendar on datefield
  24. How to query Case-insensitive data in Django ORM?
  25. Django comparing model instances for equality
  26. Token Authentication for RESTful API: should the token be periodically changed?
  27. Django: Does prefetch_related() follow reverse relationship lookup?
  28. How to add Check Constraints for Django Model fields?
  29. Django Migrations Add Field with Default as Function of Model
  30. how to write a query to get find value in a json field in django

Leave a Comment