Django Rest Framework add class level method to api

Question

I am using Django Rest Framework to create my API. I am using @link to return information about a particular object.

class SomeClassView(viewsets.ReadOnlyModelViewSet):
   @link
   def info(self, request, pk=None):
       obj = models.SomeClass.objects.get(pk=pk)
       return Response({"info": object.info()})

 GET: /someclass/1/info

What I would like to do is extend the method so I can access it at the "class level" so that my api could accept a list of objects

class SomeClassView(viewsets.ReadOnlyModelViewSet):
   @link
   def info(self, request, pk=None):
       if isinstance(s, str):
           obj = models.SomeClass.objects.get(pk=pk)
           return Response({"info": obj.info()})
       else:
           objs = models.SomeClass.objects.filter(pk__in=pk).all()
           return Response({"infos": [obj.info() for obj in objs]})

GET: /someclass/1/info
GET: /someclass/info?pk=1&pk=2&pk=3

Is there a way I can add a class level method to my api? Or will I need to create a new class to handle the one api call?

PS: I don't mind if I need to have a separate method to make this work

Jordan Carlson · Accepted Answer · 2013-10-01 09:12:19Z

3

The dynamically generated routes using the @link or @action decorators are hard-coded to look like /someclass/<pk>/<methodname>/. You can expose a /someclass/info endpoint by adding a custom route, e.g.:

class MyRouter(DefaultRouter):
    routes = [
        Route(
            url=r'^{prefix}/((?P<pk>\d+)/)?info$',
            mapping={'get': 'info'},
            name='{basename}-info',
            initkwargs={}
        )
    ] + DefaultRouter.routes

Then your info method might look like this:

def info(self, request, pk=None):
    if pk:
        obj = SomeClass.objects.get(pk=pk)
        return Response({'info': obj.info()})
    else:
        objs = SomeClass.objects.filter(pk__in=request.GET.getlist('pk'))
        return Response({'infos': [obj.info() for obj in objs]})

(Note the absence of the @link decorator.)

answered Oct 1, 2013 at 9:12

Jordan Carlson

3931 silver badge7 bronze badges

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

1 Comment

datinc Over a year ago

I was afraid of that. I would have liked the final solution to have been part of the class.

Collectives™ on Stack Overflow

Django Rest Framework add class level method to api

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related