django-filter使用文档

这篇文章距离上次修改已过243天，其中的内容可能已经有所变动。

Django-filter是一个Django应用，用于创建过滤器，以便用户可以通过不同的方式过滤查询集。以下是如何使用Django-filter的简要步骤和示例代码：

安装django-filter:

pip install django-filter

将django-filter添加到你的INSTALLED\_APPS设置中:

INSTALLED_APPS = [
    # ...
    'django_filters',
    # ...
]

在你的视图中使用DjangoFilterBackend为查询集过滤:

from django_filters.rest_framework import DjangoFilterBackend
from rest_framework import generics
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelListView(generics.ListAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['field1', 'field2']  # 需要过滤的字段

定义你的过滤器字段，在你的模型中或者单独的过滤器类中:

# 在你的模型中
class MyModel(models.Model):
    field1 = models.CharField(max_length=100)
    field2 = models.IntegerField()

    # 如果需要，可以在这里定义更复杂的过滤逻辑

# 或者在单独的过滤器类中
import django_filters
from .models import MyModel

class MyModelFilter(django_filters.FilterSet):
    class Meta:
        model = MyModel
        fields = ['field1', 'field2']

如果你使用的是过滤器类，则在视图中指定filterset\_class:

class MyModelListView(generics.ListAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    filter_backends = [DjangoFilterBackend]
    filterset_class = MyModelFilter

以上步骤和代码展示了如何在Django REST框架视图中使用django-filter来过滤查询集。根据你的具体需求，你可能需要调整字段和过滤器类的定义。

django-filter使用文档

评论已关闭

推荐阅读