Include intermediary (through model) in responses in Django Rest Framework

by

How about…..

On your MemberSerializer, define a field on it like:

groups = MembershipSerializer(source="membership_set", many=True)

and then on your membership serializer you can create this:

class MembershipSerializer(serializers.HyperlinkedModelSerializer):

    id = serializers.Field(source="group.id")
    name = serializers.Field(source="group.name")

    class Meta:
        model = Membership

        fields = ('id', 'name', 'join_date', )

That has the overall effect of creating a serialized value, groups, that has as its source the membership you want, and then it uses a custom serializer to pull out the bits you want to display.

EDIT: as commented by @bryanph, serializers.field was renamed to serializers.ReadOnlyField in DRF 3.0, so this should read:

class MembershipSerializer(serializers.HyperlinkedModelSerializer):

    id = serializers.ReadOnlyField(source="group.id")
    name = serializers.ReadOnlyField(source="group.name")

    class Meta:
        model = Membership

        fields = ('id', 'name', 'join_date', )

for any modern implementations

More Related Contents:

  1. Does the django-rest-framework provide an admin site to manage models?
  2. How can I enable CORS on Django REST Framework
  3. DRF: Simple foreign key assignment with nested serializers?
  4. Django Rest Framework File Upload
  5. How do I include related model fields using Django Rest Framework?
  6. Retrieving a Foreign Key value with django-rest-framework serializers
  7. Django REST Framework upload image: “The submitted data was not a file”
  8. Django rest framework serializing many to many field
  9. Django serializer Imagefield to get full URL
  10. django-rest-framework 3.0 create or update in nested serializer
  11. Django Rest Framework and JSONField
  12. How can I use Django OAuth Toolkit with Python Social Auth?
  13. Django Rest Framework writable nested serializers
  14. Pass extra arguments to Serializer Class in Django Rest Framework
  15. Django REST: Uploading and serializing multiple images
  16. When to use Serializer’s create() and ModelViewset’s perform_create()
  17. Django Rest Framework – Authentication credentials were not provided
  18. Logging requests to django-rest-framework
  19. Django REST Framework serializer field required=false
  20. Django Rest Framework – Could not resolve URL for hyperlinked relationship using view name “user-detail”
  21. Django Rest Framework – How to add custom field in ModelSerializer
  22. Order of Serializer Validation in Django REST Framework
  23. How can I register a single view (not a viewset) on my router?
  24. OperationalError, no such column. Django
  25. how to add annotate data in django-rest-framework queryset responses?
  26. How to use csrf_token in Django RESTful API and React?
  27. How to upload multiple files in django rest framework
  28. Override JSONSerializer on django rest framework
  29. How to add custom field in ModelSerializer?
  30. Multiple lookup_fields for django rest framework

Leave a Comment