In Django REST Framework, Using ModelViewSet with renderers,

Question

I'm using ModelViewSet and struggling to setup a rendering standard. The documentation doesn't show how to use ModelViewSet with drf renderers. I want the output to be of this format:

Format : {'message': <custom message>, 'data': <output from ModelViewSet>}

Code:

class PostViewSet(viewsets.ModelViewSet):
    serializer_class = PostSerializer
    queryset = Post.objects.all()
    permission_classes = [permissions.IsAuthenticated]
    renderer_classes = [GenericAPIRenderer]

# How to Override?
class GenericAPIRenderer(renderers.JSONRenderer):
    charset = 'utf-8'

    def render(self, data, media_type=None, renderer_context=None):
        pass

JPG · Accepted Answer · 2020-12-21 06:53:59Z

1

Something like this works without any issue,

class GenericAPIRenderer(renderers.JSONRenderer):
    charset = 'utf-8'

    def render(self, data, accepted_media_type=None, renderer_context=None):
        updated_data = {'message': "some custom message", 'data': data}
        return super().render(updated_data, accepted_media_type, renderer_context)

answered Dec 21, 2020 at 6:53

JPG

89.4k24 gold badges164 silver badges235 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Ashfaq Ur Rahman N Over a year ago

How do I pass on a custom message from the view layer?

JPG Over a year ago

if you want to inject the "custom message* from view, then, better override the corresponding methods

Iain Shelvington Over a year ago

@AshfaqUrRahmanN renderer_context seems to be the appropriate place to pass additional information, or add your own parameter

Iain Shelvington Over a year ago

@ArakkalAbu According to the docs for renderer_context: "By default this will include the following keys: view, request, response, args, kwargs.". Seems like it should contain the required data. django-rest-framework.org/api-guide/renderers/…

JPG Over a year ago

I wasn't aware of that point, thanks for the info @IainShelvington

|

Collectives™ on Stack Overflow

In Django REST Framework, Using ModelViewSet with renderers,

1 Answer 1

6 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

6 Comments

Your Answer

Sign up or log in

Post as a guest

Related