How do I include related model fields using Django Rest Framework?

by

The simplest way is to use the depth argument 

class ClassroomSerializer(serializers.ModelSerializer):
    class Meta:
        model = Classroom
        depth = 1

However, that will only include relationships for forward relationships, which in this case isn’t quite what you need, since the teachers field is a reverse relationship.

If you’ve got more complex requirements (eg. include reverse relationships, nest some fields, but not others, or nest only a specific subset of fields) you can nest serializers, eg…

class TeacherSerializer(serializers.ModelSerializer):
    class Meta:
        model = Teacher
        fields = ('id', 'name', 'tenure')

class ClassroomSerializer(serializers.ModelSerializer):
    teachers = TeacherSerializer(source="teacher_set")

    class Meta:
        model = Classroom

Note that we use the source argument on the serializer field to specify the attribute to use as the source of the field. We could drop the source argument by instead making sure the teachers attribute exists by using the related_name option on your Teacher model, ie. classroom = models.ForeignKey(Classroom, related_name="teachers")

One thing to keep in mind is that nested serializers do not currently support write operations. For writable representations, you should use regular flat representations, such as pk or hyperlinking.

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. Django Rest Framework File Upload
  4. Include intermediary (through model) in responses in Django Rest Framework
  5. Retrieving a Foreign Key value with django-rest-framework serializers
  6. Django REST Framework POST nested objects
  7. Django serializer Imagefield to get full URL
  8. Django Rest Framework and JSONField
  9. How can I use Django OAuth Toolkit with Python Social Auth?
  10. django.db.migrations.exceptions.InconsistentMigrationHistory
  11. Django Rest Framework writable nested serializers
  12. Pass extra arguments to Serializer Class in Django Rest Framework
  13. Django REST: Uploading and serializing multiple images
  14. When to use Serializer’s create() and ModelViewset’s perform_create()
  15. Django Rest Framework – Authentication credentials were not provided
  16. Logging requests to django-rest-framework
  17. Django REST Framework serializer field required=false
  18. Django Rest Framework – Could not resolve URL for hyperlinked relationship using view name “user-detail”
  19. Django Rest Framework – How to add custom field in ModelSerializer
  20. Order of Serializer Validation in Django REST Framework
  21. OperationalError, no such column. Django
  22. Django Python rest framework, No ‘Access-Control-Allow-Origin’ header is present on the requested resource in chrome, works in firefox
  23. how to add annotate data in django-rest-framework queryset responses?
  24. Django viewset has not attribute ‘get_extra_actions’
  25. How to use csrf_token in Django RESTful API and React?
  26. How to upload multiple files in django rest framework
  27. Django: app level variables
  28. How to add custom field in ModelSerializer?
  29. CSRF validation does not work on Django using HTTPS
  30. Multiple lookup_fields for django rest framework

Leave a Comment