一垢揩、過濾
official API guide—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
class UserListView(mixins.ListModelMixin, viewsets.GenericViewSet):
...
filter_backends = (DjangoFilterBackend,)
如果要允許對某些字段進行過濾琐驴，可以使用filter_fields屬性俘种。
class ProductList(mixins.ListModelMixin, viewsets.GenericViewSet):
queryset = Product.objects.all()
serializer_class = ProductSerializer
filter_backends = (DjangoFilterBackend,)
filter_fields = ('category', 'in_stock')
還可以自定義過濾類，再用filter_class指定過濾集合類
import django_filters
from myapp.models import Product
from myapp.serializers impoert ProductSerializer
from rest_framework import filters
from rest_framework import generics
class ProductFilter(filters.FilterSet):
min_price = django_filters.NumberFilter(name=’price’, lookup_type=”gte”)
max_price = django_filters.NumberFilter(name=’price’, lookup_type=”lte”)
# 行為: 名稱中包含某字符绝淡，且字符不區(qū)分大小寫
name = filters.CharFilter(name='name', lookup_expr='icontains')
class Meta:
model = Product
fields = [‘category’, ‘in_stock’, ‘min_price’, ‘max_price’]
class ProductList(mixins.ListModelMixin, viewsets.GenericViewSet):
queryset = Product.object.all()
serializer_class = ProductSerializer
filter_backends = (filter.DjangoFilterBackend,)
filter_class = ProductFilter
二、搜索
official API guide—Searching
如果要明確指定可以對哪些字段進行搜索苍姜，可以使用search_fields屬性牢酵，默認為可以對serializer_class屬性指定的串行器上的任何可讀字段進行搜索：
class UserListView(mixins.ListModelMixin, viewsets.GenericViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
filter_backends = (filters.SearchFilter,)
search_fields = ('username', 'email')
也可以使用雙下劃線在Foreign Key或ManyToManyField上執(zhí)行相關查找：
search_fields = ('username', 'email', 'profile__profession')
默認情況下，搜索將使用不區(qū)分大小寫的部分匹配衙猪。 搜索參數(shù)可以包含多個搜索項馍乙，它們應該是空格和/或逗號分隔。 如果使用多個搜索項垫释，則僅當所有提供的條款匹配時丝格，才會在列表中返回對象。默認情況下棵譬，搜索參數(shù)被命名為“search”显蝌，但這可能會被SEARCH_PARAM設置覆蓋。
The search behavior may be restricted by prepending various characters to the search_fields.
可以通過在search_fields中加入一些字符來限制搜索行為订咸，如下：
- '^' ：以xx字符串開始搜索
- '=' ：完全匹配
- '@' ：全文搜索（目前只支持Django的MySQL后端）
- '$' ：正則表達式搜索
三曼尊、排序
official API guide—Ordering
OrderingFilter類支持簡單的查詢參數(shù)控制結果排序粘招。
默認情況下竿屹，查詢參數(shù)被命名為“ordering”，但這可能會被ORDERING_PARAM設置覆蓋羽德。
可以使用ordering_fields屬性明確指定可以對哪些字段執(zhí)行排序父叙，這有助于防止意外的數(shù)據(jù)泄露神郊，例如允許用戶對密碼散列字段或其他敏感數(shù)據(jù)進行排序肴裙。
如果不指定ordering_fields屬性，則默認為可以對serializer_class屬性指定的串行器上的任何可讀字段進行過濾涌乳。
class UserListView(generics.ListAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
filter_backends = (filters.OrderingFilter,)
ordering_fields = ('username', 'email')
使用ordering屬性設置默認排序：
ordering = ('username',)
四蜻懦、分頁
可以直接在view.py中自定義分頁規(guī)則
class StandardResultsSetPagination(PageNumberPagination):
"""
配置分頁規(guī)則
"""
page_size = 12
page__size_query_param = 'page_size'
page_query_param = 'page'
max_page_size = 100
應用到視圖函數(shù)中：
class GoodsListViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):
...
pagination_class = StandardResultsSetPagination
...
PageNumberPagination：此分頁樣式在請求查詢參數(shù)中接受單個編號頁碼。
請求示例：GET https://api.example.org/accounts/?page=4
全局設置
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination'
}
- PageNumberPagination類包括可以覆蓋以修改分頁樣式的許多屬性爷怀，要設置這些屬性阻肩，應覆蓋PageNumberPagination類，然后如上所示啟用自定義分頁類运授。
- django_paginator_class：使用的Django Paginator類烤惊，默認是django.core.paginator.Paginator，對大部分用例是適用的吁朦。
- page_size：數(shù)值柒室，頁面大小，默認是全局PAGE_SIZE的值逗宜。
- page_query_param：字符串雄右，查詢參數(shù)的名稱，默認是'page'
- page_size_query_param：字符串纺讲，請求設置頁面大小的參數(shù)名稱擂仍，默認是None，表示客戶端可能無法控制請求的頁面大小熬甚。
- max_page_size：字符串逢渔，最大允許請求的頁面大小， 此屬性僅在page_size_query_param也被設置時有效乡括。
- last_page_strings：字符串列表或者元組肃廓，默認是('last',)
- template：分頁控件使用的模板的名稱，可以覆蓋或設置為None诲泌，默認為"rest_framework/pagination/numbers.html"
LimitOffsetPagination：查找多個數(shù)據(jù)庫記錄時使用的語法盲赊，客戶端包括“l(fā)imit”和“offset”查詢參數(shù)，limit指示要返回的最大項目數(shù)敷扫，并且相當于其他樣式中的page_size哀蘑，offset表示查詢起始位置。
請求示例：GET https://api.example.org/accounts/?limit=100&offset=400
全局設置
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination'
}
