django REST_FRAMEWORK 接口 django rest framework filter

一、过滤 filter

django-filter库包括一个DjangoFilterBackend类，它支持REST框架的高度可定制的字段过滤。
首先安装django-filter， 然后将django_filters添加到Django的INSTALLED_APPS。
可以设置默认返回，在settings.py加上如下配置：

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
}

或者将过滤器加到单个View或ViewSet中(一般使用这种)：

from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.viewsets import ModelViewSet

class UserListView(ModelViewSet):
    ...
    filter_backends = (DjangoFilterBackend,)

如果要允许对某些字段进行过滤，可以使用filter_fields属性

from rest_framework.viewsets import ModelViewSet
from django_filters.rest_framework import DjangoFilterBackend
from myapp.models import Product
from myapp.serializers impoert ProductSerializer

class ProductList(ModelViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer
    filter_backends = (DjangoFilterBackend,)
    filter_fields = ('category', 'in_stock')
    # filter_class = ProductFilter  (指定过滤集合类)

还可以自定义过滤类，再用filter_class指定过滤集合类

import django_filters
from myapp.models import Product
from rest_framework import filters

class ProductFilter(filters.FilterSet):
　　min_price = django_filters.NumberFilter(name=’price’, lookup_type=”gte”)
　　max_price = django_filters.NumberFilter(name=’price’, lookup_type=”lte”)
　　# 行为: 名称中包含某字符，且字符不区分大小写
　　name = filters.CharFilter(name='name', lookup_expr='icontains')
　　class Meta:
　　　　model = Product
　　　　fields = [‘category’, ‘in_stock’, ‘min_price’, ‘max_price’]

二、搜索 search

如果要明确指定可以对哪些字段进行搜索，可以使用search_fields属性，默认为可以对serializer_class属性指定的串行器上的任何可读字段进行搜索：

from django.contrib.auth.models import User
from rest_framework import viewsets
from core.serializers import UserSerializer
from rest_framework import filters

class UserListView(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    filter_backends = (filters.SearchFilter,)
    search_fields = ('username', 'email')

也可以使用双下划线在Foreign Key或ManyToManyField上执行相关查找：

search_fields = ('username', 'email', 'profile__profession')

三，排序 order

OrderingFilter类支持简单的查询参数控制结果排序。
默认情况下，查询参数被命名为“ordering”，但这可能会被ORDERING_PARAM设置覆盖。
可以使用ordering_fields属性明确指定可以对哪些字段执行排序，这有助于防止意外的数据泄露，例如允许用户对密码散列字段或其他敏感数据进行排序。
如果不指定ordering_fields属性，则默认为可以对serializer_class属性指定的串行器上的任何可读字段进行过滤。

from django.contrib.auth.models import User
from rest_framework import viewsets
from core.serializers import UserSerializer
from rest_framework import filters

class UserListView(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    filter_backends = (filters.OrderingFilter,)
    ordering_fields = ('username', 'email')

使用ordering属性设置默认排序(加"-"减号可以倒叙)：
ordering = (’-id’,)

四、分页 pagination

可以直接在view.py中自定义分页规则

from rest_framework.pagination import PageNumberPagination

class StandardResultsSetPagination(PageNumberPagination):
    """
    配置分页规则
    """
    page_size = 12
    page__size_query_param = 'page_size'
    page_query_param = 'page'
    max_page_size = 100

应用到视图函数中：

class UserListView(viewsets.ModelViewSet):
....
    pagination_class = StandardResultsSetPagination
....

可以setting全局设置：

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination'
}

• PageNumberPagination类包括可以覆盖以修改分页样式的许多属性，要设置这些属性，应覆盖PageNumberPagination类，然后如上所示启用自定义分页类。
• django_paginator_class：使用的Django
  Paginator类，默认是django.core.paginator.Paginator，对大部分用例是适用的。
• page_size：数值，页面大小，默认是全局PAGE_SIZE的值。
• page_query_param：字符串，查询参数的名称，默认是’page’
• page_size_query_param：字符串，请求设置页面大小的参数名称，默- 认是None，表示客户端可能无法控制请求的页面大小。
• max_page_size：字符串，最大允许请求的页面大小， 此属性仅在page_size_query_param也被设置时有效。
• last_page_strings：字符串列表或者元组，默认是(‘last’,)
• template：分页控件使用的模板的名称，可以覆盖或设置为None，默认为"rest_framework/pagination/numbers.html"