Django REST Framework-过滤器(四)

2023-04-25 09:04:53 浏览数 (1)

自定义过滤器

Django REST Framework还允许您创建自定义过滤器。您可以通过创建一个新的过滤器类来实现自定义过滤器。过滤器类必须继承自rest_framework.filters.BaseFilterBackend类,并实现filter_queryset(self, request, queryset, view)方法。

以下是一个自定义过滤器的示例:

代码语言:javascript复制
from rest_framework.filters import BaseFilterBackend

class CustomFilter(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        custom_param = request.query_params.get('custom_param', None)
        if custom_param is not None:
            queryset = queryset.filter(field1__contains=custom_param)
        return queryset

在上面的示例中,我们创建了一个名为CustomFilter的自定义过滤器类。它实现了filter_queryset(self, request, queryset, view)方法来过滤查询集。在这种情况下,我们检查是否传递了一个名为custom_param的查询参数,并过滤查询集以获取匹配该参数的对象。

您可以在视图中使用这个自定义过滤器类,方法如下:

代码语言:javascript复制
from rest_framework import generics
from myapp.models import MyModel
from myapp.serializers import MyModelSerializer

class MyModelList(generics.ListAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    filter_backends = [CustomFilter]
}

在上面的示例中,我们使用了自定义过滤器CustomFilter来过滤查询集。这将允许我们根据自定义参数来过滤API数据。

0 人点赞