Context Aware Browsable API Rendering in Django REST

Question

Is there an easy way to create hyperlinks in the Django Rest Browsable API, but not in the other API renderings. To be clear I would like to render certain fields as hyperlinks when viewing the page through the browsable API but to only render the text component when rendering through JSON.

An example of this use case is to render the pk in the list view as hyperlink to the detail view (similar to: http://chibisov.github.io/drf-extensions/docs/#resourceurifield) but to do this only when viewing the list view in browsable API mode. In regular json GET, I would like to render just the pk.

My hope is to make the browsable API more useable/navigable when accessing through a browser.

Is this in any way relevant: http://www.django-rest-framework.org/api-guide/renderers#browsableapirenderer?

More generally, is there anyway to set the excludes to be dependent on the rendering mode?

Tom Christie · Accepted Answer · 2014-06-24 12:48:35Z

3

You can return different serializers in different context, by overriding the get_serializer method on GenericAPIView or any of its subclasses.

Something like this would be about right...

def get_serializer(self, ...):
    if self.request.accepted_renderer.format == 'api':
        # Browsable style
    else:
        # Standard style

If you code that behaviour as a mixin class you'd then be able to easily reuse it throughout your views.

edited Jun 24, 2014 at 12:48

answered Jun 23, 2014 at 12:19

Tom Christie

34k7 gold badges104 silver badges87 bronze badges

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

1 Comment

Alex Rothberg Over a year ago

You actually have to compare against a format of 'api' not HTML.

Alex Rothberg · Accepted Answer · 2014-06-23 17:59:39Z

1

I created this mixin to use the serializer_class_api when in API mode:

class SerializerAPI(object):
    def get_serializer_class(self, *args, **kwargs):
        parent = super(SerializerAPI, self).get_serializer_class(*args, **kwargs)
        if (hasattr(self.request, 'accepted_renderer') and 
          self.request.accepted_renderer.format == 'api'):
            return self.serializer_class_api
        else:
            return parent

answered Jun 23, 2014 at 17:59

Alex Rothberg

11.2k15 gold badges69 silver badges126 bronze badges

Collectives™ on Stack Overflow

Context Aware Browsable API Rendering in Django REST

2 Answers 2

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related