Django Rest Framework Filtering does not response 'No Data Found' when no data found

Question

I have a very simple DRF ListApiView which is using filters.SearchFilter as filter_backend.

But the problem is it is returning an empty list if no data is found on the queryset.

My Code:

serializers.py

class PhoneSerializer(serializers.ModelSerializer):
    brand_name = serializers.CharField(source='brand')

    class Meta:
        model = models.Phone
        fields = '__all__'

views.py

class PhoneApiView(generics.ListAPIView):
    filter_backends = [filters.SearchFilter]
    serializer_class = serializers.PhoneSerializer
    queryset = models.Phone.objects.all()
    search_fields = ['model_name', 'jan_code']

Result for a successful search

[
    {
        "id": 6,
        "brand_name": "Oppo",
        "model_name": "Oppo Reno 5",
        "image": "http://127.0.0.1:8000/media/phone/reno-5-black-2.jpg",
        "colors": "Red, Blue",
        "jan_code": "785621716768184",
        "brand": 6
    }
]

Expected Result if nothing found (Currently returning an empty list [])

    {
        "response": 'No Data Found'
    }

Now, How do I do that? Thanks

Yusuf Ertas · Accepted Answer · 2021-12-25 21:32:34Z

2

Try to start with the filter_queryset() method and work your way to the get() method.

    def filter_queryset(self, queryset):
        for backend in list(self.filter_backends):
            queryset = backend().filter_queryset(self.request, queryset, self)
        return queryset

    def get_queryset(self):
        return Phone.objects.all()

    def get(self, request):
        filtered_qs = self.filter_queryset(self.get_queryset())

        
        serializer = PhoneSerializer(filtered_qs, data=request.data)
        serializer.is_valid(raise_exception=True)
        if not filtered_qs.exists():
            return Response({'response': 'No Data Found'})
        return Response(serializer.data)

edited Dec 25, 2021 at 21:32

answered Dec 25, 2021 at 20:07

Yusuf Ertas

3062 silver badges8 bronze badges

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

10 Comments

Nahidujjaman Hridoy Over a year ago

yes got an error The response content must be rendered before it can be iterated over. when no data found

Yusuf Ertas Over a year ago

I have edited my post above. The response is now returned in the get method instead of the filter_queryset() method.

Nahidujjaman Hridoy Over a year ago

I don't know what I am doing wrong but this time correct search returns some error.

Yusuf Ertas Over a year ago

Can you post the error message?

Nahidujjaman Hridoy Over a year ago

validate() got an unexpected keyword argument 'raise_exception' This is the error message I am getting.

|

Collectives™ on Stack Overflow

Django Rest Framework Filtering does not response 'No Data Found' when no data found

1 Answer 1

10 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

10 Comments

Your Answer

Sign up or log in

Post as a guest

Related