
1.在settings里重写REST_frameWORK
过滤:DjangoFilterBackend
排序:OrderingFilter
分页:DEFAULT_PAGINATION_CLASS'
REST_frameWORK = {
# 默认响应渲染类
'DEFAULT_RENDERER_CLASSES': (
# json渲染器为第一优先级
'rest_framework.renderers.JSONRenderer',
# 可浏览的API渲染器为第二优先级,不需要则取消
'rest_framework.renderers.BrowsableAPIRenderer',
),
# # django_filters.rest_framework.backends.DjangoFilterBackend
'DEFAULT_FILTER_BACKENDS': [
'django_filters.rest_framework.DjangoFilterBackend',
'rest_framework.filters.OrderingFilter'
],
# DEFAULT_PAGINATION_CLASS全局指定分页引擎类
# 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'DEFAULT_PAGINATION_CLASS': 'utils.pagination.ManualPageNumberPagination',
# 一定要指定, 每一页获取的条数
'PAGE_SIZE': 10,
}
2. 在utils新建自定义分页文件
pagination.py
# -*- coding: utf-8 -*-
from rest_framework.pagination import PageNumberPagination
class ManualPageNumberPagination(PageNumberPagination):
# 前端用户指定的页面key的名称
# page_query_param = 'page'
# 前端用户指定的每一页条数key的名称
page_size_query_param = 'size'
max_page_size = 20
# 指定默认每一页2条数据
# page_size = 10
page_query_description = "第几页"
page_size_query_description = "每页几条"
def get_paginated_response(self, data):
response = super().get_paginated_response(data)
# "total_pages": 6,
# "current_page_num": 2
response.data["current_page_num"] = self.page.number
response.data["total_pages"] = self.page.paginator.num_pages
return response
3.修改views类视图
from django.http import JsonResponse, Http404
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.generics import GenericAPIView
from rest_framework.response import Response
from projects.models import Projects
from . import serializers
from rest_framework import status
from rest_framework.filters import OrderingFilter
class ProjectList(GenericAPIView):
# qs = Projects.objects.all()
# 往往要指定queryset查询集类属性,不能改成其他名字
queryset = Projects.objects.all()
# 往往需要用serializer_class指定序列化器类
serializer_class = serializers.ProjectModelSerializer
# 指定过滤的引擎,以后过滤都使用这个,可以在全局使用
filter_backends = [DjangoFilterBackend, OrderingFilter]
# 指定过滤字段
filterset_fields = ['name', 'leader', 'tester']
# 指定排序字段,前端需要使用ordering作为key,指定的字段名作为value,一般默认升序,如要降序加-号
ordering_fields = ['name', 'leader', 'tester']
def get(self, request):
"""
获取项目列表数据
:param request:
:return:
"""
# 1. 从数据库中获取所有项目信息,all返回的是查询集
# projects_qs = Projects.objects.all()
# projects_qs = self.queryset
# 使用get_queryset方法获取查询集可以过滤一些数据
projects_qs = self.get_queryset() # 项目中有100条数据
projects_qs = self.filter_queryset(projects_qs) # 根据前端的传参,过滤以后只有20个
# name = request.query_params.get('name')
# if name is not None:
# projects_qs = projects_qs.filter(name__contains=name)
# 使用get_queryset获取查询集
# 分页操作
# page为分页之后的查询集对象
page = self.paginate_queryset(projects_qs)
if page is not None:
serializer = self.get_serializer(instance=page, many=True)
return self.get_paginated_response(serializer.data)
serializer = self.get_serializer(instance=projects_qs, many=True)
return Response(serializer.data)
def post(self, request):
# 2.向数据库中新增项目
# 1.继承DRF框架中APIView之后,request是DRF中Response对象
# 2.Response对HttpRequest进行了拓展,HttpRequest有的功能Response都支持
# 3.不管前端传json还是x-www-form参数,统一使用request.data
serializer = self.get_serializer(data=request.data)
# if not serializer.is_valid():
# return JsonResponse(serializer.errors, status=400)
# d. is_valid方法中,raise_exception设置为True, 那么校验失败之后,会自动抛出异常,异常信息会被自动处理
try:
serializer.is_valid(raise_exception=True)
except Exception:
return JsonResponse(serializer.errors, status=400)
# 可以通过序列化对象中的validated_data属性获取校验通过之后的数据
# project = Projects.objects.create(**serializer.validated_data)
# a.在创建序列化器对象时,如果只给data传参,那么使用序列化器对象调用save方法,只调用create(),用于创建项目
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
class ProjectDetail(GenericAPIView):
def get_object(self, pk):
try: # 如果ID存在则直接返回,不存在则返回404
return Projects.objects.get(pk=pk)
except Projects.DoesNotExist:
# return JsonResponse({"msg": "项目ID不存在"}, status=400)
raise Http404
def get(self, requests, pk):
"""获取指定项目信息
:param requests:
:param pk:
:return:
"""
# one_project = self.get_object(pk)
# 根据传入的ID过滤一个
one_project = self.get_object()
# 在上边定义了self.serializer_class,可以直接调用替换serializers.ProjectModelSerializer
# serializer = self.serializer_class(instance=one_project)
# 以后获取需要使用的序列化器类,不要用serializer_class,而是使用get_serializer方法去获取
serializer = self.get_serializer(instance=one_project)
# 如果请求头中没有Accept,那么默认返回json
# 如果请求头中已添加了Accept,那么会以Accept的格式返回
# data需要接收序列化处理的数据,为python中的字典或在嵌套字典的列表
return Response(data=serializer.data, status=status.HTTP_200_OK)
def put(self, request, pk):
"""更新指定项目
:param request:
:param pk:
:return:
"""
# 1.校验前端传递的pk(项目ID)值
# 2.获取指定PK值的项目
one_project = self.get_object()
serializer = self.get_serializer(instance=one_project, data=request.data)
# if not serializer.is_valid():
# return JsonResponse(serializer.errors, status=400)
# d. is_valid方法中,raise_exception设置为True, 那么校验失败之后,会自动抛出异常,异常信息会被自动处理
try:
serializer.is_valid(raise_exception=True)
except Exception:
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
# 4.向数据库中更新项目
python_data = serializer.validated_data
one_project.save()
# 5.返回结果(将更新之后的项目数据返回)
one_dict = {
"id": one_project.id,
"name": one_project.name,
"leader": one_project.leader,
"tester": one_project.tester,
"programmer": one_project.programmer,
"publish_app": one_project.publish_app,
"desc": one_project.desc,
}
return JsonResponse(one_dict, status=201)
def delete(self, request, pk):
"""删除指定的数据
:param request:
:param pk:
:return:
"""
# 1.校验前端传递的pk值
# 2.获取指定pk值的项目
one_project = self.get_object(pk)
# 3.删除项目
one_project.delete()
# 4.返回
return Response(None, status=status.HTTP_204_NO_CONTENT)
4.请求地址:
http://127.0.0.1:8000/projects/?