对于列表数据可能需要根据字段进行过滤,我们可以通过添加 django-filter
扩展来增强支持。
pip install django-filter
在配置文件中增加过滤后端的设置:
INSTALLED_APPS = [ ... ‘django_filters‘, # 需要注册应用, ]
在settings文件中配置:
REST_FRAMEWORK = { ‘DEFAULT_FILTER_BACKENDS‘: (‘django_filters.rest_framework.DjangoFilterBackend‘,) # 全局配置,对全部视图的查询多条接口都有过滤功能,但是视图里要指定字段 }
视图中指定要过滤的字段:
class EmployeeViewSet(ModelViewSet): queryset = Employee.objects.all() serializer_class = EmployeeSerializer # 指定可以根据哪些字段进行列表数据的过滤 filter_fields = (‘gender‘, ‘department‘)
class EmployeeViewSet(ModelViewSet): queryset = Employee.objects.all() serializer_class = EmployeeSerializer # 指定过滤器 filter_backends = [DjangoFilterBackend] # 指定可以根据哪些字段进行列表数据的过滤 filterset_fields = (‘gender‘, ‘department‘)
访问127.0.0.1/employees?gender=1时可以过滤出性别字段是1的数据。
===================================================================================================================================
对于列表数据,REST framework 提供了 OrderingFilter
过滤器 来实现按指定字段进行排序的功能
使用方法:
- 在类视图中设置
filter_backends
,使用rest_framework.filters.OrderingFilter(自带的模块,导包时注意)
过滤器:REST framework会在请求的查询字符串参数中检查是否包含了ordering
参数,如果包含,则按照ordering
参数指定的字段对数据集进行排序。- 在类视图中指定
ordering_fields
属性,表示前端请求列表数据时,可以通过哪些字段进行排序
设置示例:
class EmployeeViewSet(ModelViewSet): queryset = Employee.objects.all() serializer_class = EmployeeSerializer # 新增排序的过滤器 filter_backends = [..., OrderingFilter] # 指定可以根据哪此字段进行排序 ordering_fields = (‘age‘, ‘salary‘)
使用示例:
访问127.0.0.1/employees/?ordering=age(年龄升序)
访问127.0.0.1/employees/?ordering=-age(年龄降序)
访问127.0.0.1/employees/?ordering=age,-salary(先安装年龄升序来排,如果年龄一样,按工资升序来排)