APIView 上的 Django 过滤器

Question

我有一个 APIView 类，用于显示所有租金以及发布和删除等。现在我想要搜索功能，所以我尝试使用 DjangoFilterBackend 但它不起作用。我在文档中看到，它已与 ListAPIView 一起使用，但我如何在 APIView 中使用它。

class Rent(APIView):
    """
    List all the rents if token is not provided else a token specific rent
    """
    serializer_class = RentSerializer
    filter_backends = (DjangoFilterBackend,)
    filter_fields = ('city', 'place', 'property_category',)
    search_fields = ('=city', '=place')
    def get(self, request, token=None, format=None):
        reply={}
        try:
            rents = Rental.objects.all()
            if token:
                rent = Rental.objects.get(token=token)
                reply['data'] = self.serializer_class(rent).data
            else:
                reply['data'] = self.serializer_class(rents, many=True).data
        except Rental.DoesNotExist:
            return error.RequestedResourceNotFound().as_response()
        except:
            return error.UnknownError().as_response()
        else:
            return Response(reply, status.HTTP_200_OK)

当我在 url 中使用以下参数搜索租金时，我会得到所有租金，相反，我应该只获得位于加德满都市的租金并放置 koteshwor

http://localhost:8000/api/v1/rents?city=Kathmandu&place=Koteshwor

Answer 1

要使用 DjangoFilterBackend 的功能，您可以合并来自 GenericViewSet 的 filter_queryset 方法，这是从 APIView 继承的 DRF 类，并导致 DRF 中所有特定的“通用”视图类。它看起来像这样：

def filter_queryset(self, queryset):
    """
    Given a queryset, filter it with whichever filter backend is in use.
    You are unlikely to want to override this method, although you may need
    to call it either from a list view, or from a custom `get_object`
    method if you want to apply the configured filtering backend to the
    default queryset.
    """
    for backend in list(self.filter_backends):
        queryset = backend().filter_queryset(self.request, queryset, self)
    return queryset

https://github.com/encode/django-rest-framework/blob/master/rest_framework/generics.py

Answer 2

这里如果你使用APIView，和过滤器没有关系。所以你必须这样做

get_data = request.query_params #or request.GET check both

然后

Rental.objects.filter(city=get_data['city'], place=get_data['place'])

Answer 3

如果有人想知道我们如何将 django_filters filter_class 与 api_views 集成：

@api_view(['GET'])
@permission_classes([permissions.IsAuthenticated])
def filter_data(request, format=None):
    qs = models.YourModal.objects.all()

    filtered_data = filters.YourFilter(request.GET, queryset=qs)
    filtered_qs = filtered_data.qs
    ....
    return response.Ok(yourData)

Answer 4

添加到@ChidG 的答案。您需要做的就是覆盖 DjangoFilterBackend 的 filter_queryset 方法，它是过滤器的入口点，并将 APIView 的实例传递给它。这里要注意的重要一点是，您必须在视图上声明 filter_fields 或 filter_class 才能使过滤器工作。否则它只会返回未过滤的查询集。

如果您对它的工作原理更加好奇，该课程位于django_filters.rest_framework.backends.py

在本例中，网址类似于{base_url}/foo?is_active=true

from django_filters.rest_framework import DjangoFilterBackend

class FooFilter(DjangoFilterBackend):

    def filter_queryset(self, request, queryset, view):
        filter_class = self.get_filter_class(view, queryset)

        if filter_class:
            return filter_class(request.query_params, queryset=queryset, request=request).qs
        return queryset

class Foo(APIView):

    permission_classes = (AllowAny,)
    filter_fields = ('name', 'is_active')

    def get(self, request, format=None):
        queryset = Foo.objects.all()

        ff = FooFilter()
        filtered_queryset = ff.filter_queryset(request, queryset, self)

        if filtered_queryset.exists():
            serializer = FooSerializer(queryset, many=True)
            return Response(serializer.data, status=status.HTTP_200_OK)
        else:
            return Response([], status=status.HTTP_200_OK)