How to filter for multiple ids from a query param on a GET request with django rest framework?
Based in your comment, you could send the ids via url:
127.0.0.1:8000/snippets/?ids=2,3,4
and in your view
...
ids = request.GET.get('ids') # u'2,3,4' <- this is unicode
ids = ids.split(',') # [u'2',u'3',u'4'] <- this is a list of unicodes with ids values
Then you can query to Snippet model:
Snippet.objects.filter(pk__in=ids)
This could give you some problems if there's spaces between ids in url:
127.0.0.1:8000/snippets/?ids=2, 3 , 4
You could need process every value before perform a query
I found this to work, following the Django REST Framework main tutorial and then documentation on Filtering against query parameters, adapting slightly. This allows a single url to return data from two GET requests: one returning objects whose ids match those given as a parameter, the other returning all objects, when no parameters are provided.
- http://127.0.0.1:8000/snippets/ returns all snippets
- http://127.0.0.1:8000/snippets/?ids=2,3,7 returns only snippets with id 2, 3 and 7
snippets/urls.py
from django.conf.urls import url
from snippets import views
urlpatterns = [
.... (code for other urls here)
url(r'^snippets/$', views.SnippetList.as_view(), name='snippet-list'),
....
]
snippets/views.py
....
from snippet.serializers import SnippetSerializer
....
class SnippetList(generics.ListCreateAPIView):
serializer_class = SnippetSerializer
def get_queryset(self):
# Get URL parameter as a string, if exists
ids = self.request.query_params.get('ids', None)
# Get snippets for ids if they exist
if ids is not None:
# Convert parameter string to list of integers
ids = [ int(x) for x in ids.split(',') ]
# Get objects for all parameter ids
queryset = Product.objects.filter(pk__in=ids)
else:
# Else no parameters, return all objects
queryset = Product.objects.all()
return queryset
snippets/serializers.py
....
class SnippetSerializer(serializers.ModelSerializer):
class Meta:
model = Snippet
fields = ('url', 'id', 'title', 'code', 'linenos', 'language', 'style')
You can use django-filter and set it up as a filter and avoid over riding the get_queryset method on the viewset
Given this request
/api/snippets/?ids=1,2,3,4
Then write a django filter set and method
import django_filters
def filter_by_ids(queryset, name, value):
values = value.split(',')
return queryset.filter(id__in=values)
class SnippetFilterSet(django_filters.FilterSet):
ids = django_filters.CharFilter(method=filter_by_ids)
class Meta:
model = Snippet
fields = ['ids']
And then in your ModelViewSet
from rest_framework.viewsets import ModelViewSet
from app.snippets.models import Snippet
from app.snippets.filters import SnippetFilterSet # path to filterset
class SnippetView(ModelViewSet):
queryset = Snippet.objects.all()
serializer_class = SnippetSerializer
filterset_class = SnippetFilterSet