一、过滤Filtering

对于列表数据可能需要根据字段进行过滤，我们可以通过添加django-fitlter扩展来增强支持。

pip install django-filter

在配置文件中增加过滤后端的设置：

INSTALLED_APPS = [ ... 'django_filters', # 需要注册应用， ] REST_FRAMEWORK = { 'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',) }

在视图中添加filter_fields属性，指定可以过滤的字段

class BookListView(ListAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer filter_fields = ('btitle', 'bread') # 127.0.0.1:8000/books/?btitle=西游记

二、排序

对于列表数据，REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。

使用方法：

在类视图中设置filter_backends，使用rest_framework.filters.OrderingFilter过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。

前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。

示例：

class BookListView(ListAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer filter_backends = [OrderingFilter] ordering_fields = ('id', 'bread', 'bpub_date') # 127.0.0.1:8000/books/?ordering=-bread

三、分页Pagination

REST framework提供了分页的支持。

我们可以在配置文件中设置全局的分页方式，如：

REST_FRAMEWORK = { 'DEFAULT_PAGINATION_CLASS': '<全局分页类>', 'PAGE_SIZE': <页容量> }

如:

REST_FRAMEWORK = { 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination', 'PAGE_SIZE': 5 # 每页数目 }

可选分页类

1） PageNumberPagination

前端访问网址形式：

GET http://api.example.org/books/?page=4

可以在子类中定义的属性：

page_size 每页数目page_query_param 前端发送的页数关键字名，默认为"page"page_size_query_param 前端发送的每页数目关键字名，默认为Nonemax_page_size 前端最多能设置的每页数量

2）LimitOffsetPagination

前端访问网址形式：

GET http://api.example.org/books/?limit=100&offset=400

可以在子类中定义的属性：

default_limit 默认限制，默认值与PAGE_SIZE设置一直limit_query_param limit参数名，默认'limit'offset_query_param offset参数名，默认'offset'max_limit 最大limit限制，默认None

注意：如果在视图内关闭分页功能，只需在视图内设置

pagination_class = None

自定义分页类

也可通过自定义Pagination类，来为视图添加不同分页行为。在视图中通过pagination_clas属性来指明。

class StandardResultPagination(PageNumberPagination): page_size = 3 page_size_query_param = 'page_size' max_page_size = 5 class BookListView(ListAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer # 指定当前视图所使用的分页类 pagination_class = StandardResultPagination

通过 http://api.example.org/books/?page=<页码>&page_size=<页容量> 进行访问。