Adding root element to json response (django-rest-framework)

by

For posterity, below is the final solution. It has grown slightly from the original as it now reformats paginated results as well.

Also I should have specified before, that the reason for the JSON root element is for integration with an Ember front end solution.

serializer:

from rest_framework.serializers import ModelSerializer
from api.models import Contact

class ContactSerializer(ModelSerializer):
    class Meta:
        model = Contact
        #define the resource we wish to use for the root element of the response
        resource_name="contact" 
        fields = ('id', 'first_name', 'last_name', 'phone_number', 'company')

renderer:

from rest_framework.renderers import JSONRenderer

class CustomJSONRenderer(JSONRenderer):
    """
        Override the render method of the django rest framework JSONRenderer to allow the following:
        * adding a resource_name root element to all GET requests formatted with JSON
        * reformatting paginated results to the following structure {meta: {}, resource_name: [{},{}]}

        NB: This solution requires a custom pagination serializer and an attribute of 'resource_name'
        defined in the serializer
    """
    def render(self, data, accepted_media_type=None, renderer_context=None):
        response_data = {}

        #determine the resource name for this request - default to objects if not defined
        resource = getattr(renderer_context.get('view').get_serializer().Meta, 'resource_name', 'objects')

        #check if the results have been paginated
        if data.get('paginated_results'):
            #add the resource key and copy the results
            response_data['meta'] = data.get('meta')
            response_data[resource] = data.get('paginated_results')
        else:
            response_data[resource] = data

        #call super to render the response
        response = super(CustomJSONRenderer, self).render(response_data, accepted_media_type, renderer_context)

        return response

pagination:

from rest_framework import pagination, serializers

class CustomMetaSerializer(serializers.Serializer):
    next_page = pagination.NextPageField(source="*")
    prev_page = pagination.PreviousPageField(source="*")
    record_count = serializers.Field(source="paginator.count")

class CustomPaginationSerializer(pagination.BasePaginationSerializer):
    # Takes the page object as the source
    meta = CustomMetaSerializer(source="*")
    results_field = 'paginated_results'

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: Dynamically return subset of fields
  10. Django Rest Framework with ChoiceField
  11. SocketException: OS Error: Connection refused, errno = 111 in flutter using django backend
  12. How to set current user to user field in Django Rest Framework?
  13. 405 POST method not allowed
  14. “Post Image data using POSTMAN”
  15. CSRF Failed: CSRF token missing or incorrect
  16. How to register users in Django REST framework?
  17. AngularJS + Django Rest Framework + CORS ( CSRF Cookie not showing up in client )
  18. How do you filter a nested serializer in Django Rest Framework?
  19. How to get Request.User in Django-Rest-Framework serializer?
  20. Pass request context to serializer from Viewset in Django Rest Framework
  21. Django Rest Framework: Disable field update after object is created
  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