Validation on query_params in Django Rest Framework

Question

I want to return model_info only if query_params is given otherwise it should give some error message.

I tried below code but it is giving me keyerror when name is not passed in query params .

from rest_framework.validators import ValidationError

class ModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = ModelName
        fields = ('name', 'abbreviation')

    def validate_name(self, value):
        if value:
            return value
        else:
            raise ValidationError('Enter name')



class ModelNameListList(generics.ListCreateAPIView):
    renderer_classes = (JSONRenderer, )
    serializer_class = ModelSerializer

    def get_queryset(self):
        queryset = ModelName.objects.all()
        name = self.request.query_params['name']
        queryset = queryset.filter(Q(name__icontains=name) | Q(abbreviation__icontains=name)).all()
        return queryset

I cannot use get method because I am also using pagination, If I will use get method it will return me all the results.

When I am using below code in get_queryset I am getting response object has no length

   def get_queryset(self):
        queryset = ModelName.objects.all()
        name = self.request.query_params.get('name', None)
        if name:
            queryset = queryset.filter(Q(name__icontains=name) | Q(abbreviation__icontains=name)).all()
        else:
            content = {'errors': 'name is missing'}
            return Response(content)
        return queryset

djq · Accepted Answer · 2015-09-19 13:04:22Z

6

With this function:

  def get_queryset(self):
        queryset = ModelName.objects.all()
        name = self.request.query_params.get('name', None)
        if name:
            queryset = queryset.filter(Q(name__icontains=name) | Q(abbreviation__icontains=name)).all()
        else:
            raise exceptions.ParseError("name not supplied")
        return queryset

You should make sure you are always returning a queryset (or raising an exception if that is how you want to handle it).

answered Sep 19, 2015 at 13:04

djq

15.4k47 gold badges126 silver badges159 bronze badges

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

2 Comments

connorbode Over a year ago

Should probably be exceptions.ValidationError -- ParseError is reserved for malformed data according to the docs whereas ValidationError is for well-formed data that doesn't meet the validation guidelines.

Lal Over a year ago

@connorbode i was thinking same but when i try to raise ValidationError from View it throws server 500 error says Validation Error at ./../ instead of a well formed JSON response. I think ValidationError is stick to Serializers. not sure

Collectives™ on Stack Overflow

Validation on query_params in Django Rest Framework

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related