Django Rest Framework: Dynamically return subset of fields

by

You can override the serializer __init__ method and set the fields attribute dynamically, based on the query params. You can access the request object throughout the context, passed to the serializer.

Here is a copy&paste from Django Rest Framework documentation example on the matter:

from rest_framework import serializers

class DynamicFieldsModelSerializer(serializers.ModelSerializer):
    """
    A ModelSerializer that takes an additional `fields` argument that
    controls which fields should be displayed.
    """

    def __init__(self, *args, **kwargs):
        # Instantiate the superclass normally
        super(DynamicFieldsModelSerializer, self).__init__(*args, **kwargs)

        fields = self.context['request'].query_params.get('fields')
        if fields:
            fields = fields.split(',')
            # Drop any fields that are not specified in the `fields` argument.
            allowed = set(fields)
            existing = set(self.fields.keys())
            for field_name in existing - allowed:
                self.fields.pop(field_name)


class UserSerializer(DynamicFieldsModelSerializer, serializers.HyperlinkedModelSerializer):

    class Meta:
        model = User
        fields = ('url', 'username', 'email')

More Related Contents:

  1. Django Rest Framework remove csrf
  2. Django rest framework, use different serializers in the same ModelViewSet
  3. How do I create multiple model instances with Django Rest Framework?
  4. Django rest framework nested self-referential objects
  5. Custom error messages in Django Rest Framework serializer
  6. Django REST Framework: adding additional field to ModelSerializer
  7. How to change field name in Django REST Framework
  8. How do you use the django-filter package with a list of parameters?
  9. Django Rest Framework with ChoiceField
  10. SocketException: OS Error: Connection refused, errno = 111 in flutter using django backend
  11. How to set current user to user field in Django Rest Framework?
  12. 405 POST method not allowed
  13. “Post Image data using POSTMAN”
  14. CSRF Failed: CSRF token missing or incorrect
  15. How to register users in Django REST framework?
  16. AngularJS + Django Rest Framework + CORS ( CSRF Cookie not showing up in client )
  17. How do you filter a nested serializer in Django Rest Framework?
  18. How to get Request.User in Django-Rest-Framework serializer?
  19. Pass request context to serializer from Viewset in Django Rest Framework
  20. Django Rest Framework: Disable field update after object is created
  21. Adding root element to json response (django-rest-framework)
  22. Token Authentication for RESTful API: should the token be periodically changed?
  23. Authorization Credentials Stripped — django, elastic beanstalk, oauth
  24. How to programmatically call a Django Rest Framework view within another view?
  25. Django REST Framework image upload
  26. Django/DRF – 405 Method not allowed on DELETE operation
  27. How to pass extra context to Django Rest Framework serializers
  28. How can I test binary file uploading with django-rest-framework’s test client?
  29. Django Rest framework, how to include ‘__all__’ fields and a related field in ModelSerializer ?
  30. context in nested serializers django rest framework

Leave a Comment