Capture parameters in django-rest-framework

Question

suppose this url:

http://localhost:8000/articles/1111/comments/

i'd like to get all comments for a given article (here the 1111).

This is how i capture this url:

url(r'^articles/(?P<uid>[-\w]+)/comments/$', comments_views.CommentList.as_view()),

The related view looks like to:

class CommentList(generics.ListAPIView):    
    serializer_class = CommentSerializer
    permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
    lookup_field = "uid"

    def get_queryset(self):
        comments = Comment.objects.filter(article= ???)
        return comments

For information, the related serializer

class CommentSerializer(serializers.ModelSerializer):
    owner = UserSerializer()

    class Meta:
        model = Comment
        fields = ('id', 'content', 'owner', 'created_at')

As you can see, I've updated my get_queryset to filter comments on the article but I don't know how to catch the "uid" parameter. With an url ending with ?uid=value, i can use self.request.QUERY_PARAMS.get('uid') but in my case, I don't know how to do it. Any idea?

Scott Woodall · Accepted Answer · 2014-01-22 20:54:25Z

102

The url parameter is stored in self.kwargs. lookup_field is the field (defaults to pk) the generic view uses inside the ORM when looking up individual model instances, lookup_url_kwarg is probably the property you want.

So try the following:

class CommentList(generics.ListAPIView):    
    serializer_class = CommentSerializer
    permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
    lookup_url_kwarg = "uid"

    def get_queryset(self):
        uid = self.kwargs.get(self.lookup_url_kwarg)
        comments = Comment.objects.filter(article=uid)
        return comments

answered Jan 22, 2014 at 20:54

Scott Woodall

10.7k7 gold badges41 silver badges37 bronze badges

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

3 Comments

billyJoe Over a year ago

thanks !! i've tried unsuccessfully to build a custom mixins (django-rest-framework.org/api-guide/…) but your solution works fine. :)

Manjit Kumar Over a year ago

You may want to explore this library which takes query params and put filters on queryset in an elegant way. github.com/manjitkumar/drf-url-filters

Wafula Samuel Over a year ago

Hey @Scott Woodall, I had a similar problem, now I sorted it out. My concern here now is, is this lookup_url_kwarg a must? How about if I I'm having multiple params? e.g uid, some_thing_else? Is it ok to just do this way comments = Comment.objects.filter(article=self.kwargs.get('uid')) ?

Collectives™ on Stack Overflow

Capture parameters in django-rest-framework

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related