Django Rest_Framework（二）
文章目录
- 1. http请求响应
-
- 1.1. 请求与响应
-
- 1.1.1 Request
-
- 1.1.1.1 常用属性
-
- 1）.data
- 2）.query_params
- 3）request._request
- 基本使用
- 1.1.2 Response
-
- 1.1.2.1 构造方式
- 1.1.2.2 response对象的属性
-
- 1）.data
- 2）.status_code
- 3）.content
- 1.1.2.3 状态码
-
- 1）信息告知 - 1xx
- 2）成功 - 2xx
- 3）重定向 - 3xx
- 4）客户端错误 - 4xx
- 5）服务器错误 - 5xx
- 1. 视图
-
- 1.2 普通视图
-
- 1.2.1 2个视图基类
-
- 1.2.1.1 APIView基本视图类
- 1.2.1.2 GenericAPIView[通用视图类]
-
- get_serializer(self, *args, \**kwargs)
- 1.2.2 5个视图扩展类
-
- 1）ListModelMixin
- 2）CreateModelMixin
- 3）RetrieveModelMixin
- 4）UpdateModelMixin
- 5）DestroyModelMixin
- 1.2.3 9个视图子类
-
- 1）CreateAPIView
- 2）ListAPIView
- 3）RetrieveAPIView
- 4）DestoryAPIView
- 5）UpdateAPIView
- 6）ListCreateAPIView
- 7）RetrieveUpdateAPIView
- 8）RetrieveDestoryAPIView
- 9）RetrieveUpdateDestoryAPIView
- 1.3 视图集ViewSet
-
- 1.3.1 常用视图集父类
-
- 1） ViewSet
- 2）GenericViewSet
- 3）ModelViewSet
- 4）ReadOnlyModelViewSet
- 2. 路由Routers
-
- 2.1 使用方法
- 2.2 视图集中附加action的声明
- 2.3 路由router形成URL的方式
什么时候声明的序列化器需要继承序列化器基类Serializer，什么时候继承模型序列化器类ModelSerializer？
继承序列化器类Serializer
字段声明
验证
添加/保存数据功能
继承模型序列化器类ModelSerializer
字段声明[可选,看需要]
Meta声明
验证
添加/保存数据功能[可选]
看数据是否从mysql数据库中获取，如果是则使用ModelSerializer，不是则使用Serializer
1. http请求响应
drf除了在数据序列化部分简写代码以外，还在视图中提供了简写操作。所以在django原有的django.views.View类基础上，drf封装了多个视图子类出来提供给我们使用。
Django REST framwork 提供的视图的主要作用：
- 控制序列化器的执行（检验、保存、转换数据）
- 控制数据库查询的执行
- 调用请求类和响应类[这两个类也是由drf帮我们再次扩展了一些功能类。]
为了方便我们学习，所以先创建一个子应用req
python manage.py startapp req
注册子引用：
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework',
'students',
'sers', # 序列化器
"school", # 序列化器嵌套
'req', # 请求与响应
]
注册路由
# 子应用路由
from django.urls import path
from . import views
urlpatterns = [
]
# 总路由
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('students/', include("students.urls")),
path('sers/', include("sers.urls")),
path('school/', include("school.urls")),
path("req/", include("req.urls")),
]
1.1. 请求与响应
内容协商：drf在django原有的基础上，新增了一个request对象继承到了APIVIew视图类，并在django原有的HttpResponse响应类的基础上实现了一个子类rest_framework.response.Response响应类。这两个类，都是基于内容协商来完成数据的格式转换的。
request->parser解析类->识别客户端请求头中的Content-Type来完成数据转换成->类字典(QueryDict，字典的子类)
response->renderer渲染类->识别客户端请求头的"Accept"来提取客户端期望的返回数据格式，-> 转换成客户端的期望格式数据
1.1.1 Request
REST framework 传入视图的request对象不再是Django默认的HttpRequest对象，而是REST framework提供的扩展了HttpRequest类的Request类的对象。
REST framework 提供了Parser解析器，在接收到请求后会自动根据Content-Type指明的请求数据类型（如JSON、表单等）将请求数据进行parse解析，解析为类字典[QueryDict]对象保存到Request对象中。
Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。
无论前端发送的哪种格式的数据，我们都可以以统一的方式读取数据。
1.1.1.1 常用属性
1）.data
request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性，但提供如下特性：
- 包含了解析之后的文件和非文件数据
- 包含了对POST、PUT、PATCH请求方式解析后的数据
- 利用了REST framework的parser解析器，不仅支持表单类型数据，也支持JSON数据
2）.query_params
query_params，查询参数，也叫查询字符串(query string )
request.query_params与Django标准的request.GET相同，只是更换了更正确的名称而已。
3）request._request
获取django封装的Request对象
基本使用
视图代码：
from django.views import View
from django.http.response import HttpResponse
from django.http.request import HttpRequest
from django.core.handlers.wsgi import WSGIRequest
class ReqView(View):
def get(self,request):
print(request)
return HttpResponse("ok")
"""
默认情况下, 编写视图类时，如果继承的是django内置的django.view.View视图基类，
则视图方法中得到的request对象，是django默认提供的django.core.handlers.wsgi.WSGIRequest
WSGIRequest这个请求处理对象，无法直接提供的关于json数据数据处理。
在编写api接口时很不方便，所以drf为了简写这块内容，在原来的HttpRequest的基础上面，新增了一个Request对象
这个Request对象是单独声明的和原来django的HttpRequest不是父子关系。
同时注意：
要使用drf提供的Request请求处理对象，必须在编写视图类时继承drf提供的视图基类
from rest_framework.views import APIView
如果使用drf提供的视图基类APIView编写类视图，则必须使用来自drf提供的Request请求对象和Response响应对象
"""
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
class ReqAPIView(APIView):
def get(self,request):
# rest_framework.request.Request对象
print(request) #
"""
print(request.FILES) # 获取上传文件列表
# 要获取django原生提供的HttpRequest对象，可以通过request._request来获取到
print(request._request.META.get("Accept")) # 当值为None时，drf默认在响应数据时按json格式返回
# response = Response(data="not ok", status=204, headers={"Company":"Oldboy"})
response = Response(data="not ok", status=status.HTTP_400_BAD_REQUEST, headers={"Company":"Oldboy"})
return response
1.1.2 Response
rest_framework.response.Response
REST framework提供了一个响应类Response，使用该类构造响应对象时，响应的具体数据内容会被转换（renderer渲染器）成符合前端需求的类型。
REST framework提供了Renderer 渲染器，用来根据请求头中的Accept（接收数据类型声明）来自动转换响应数据到对应格式。如果前端请求中未进行声明Accept，则会采用Content-Type方式处理响应数据，我们可以通过配置来修改默认响应格式。
可以在rest_framework.settings查找所有的drf默认配置项
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': ( # 默认响应渲染类
'rest_framework.renderers.JSONRenderer', # json渲染器，返回json数据
'rest_framework.renderers.BrowsableAPIRenderer', # 浏览器API渲染器，返回调试界面
)
}
1.1.2.1 构造方式
Response(data, status=None, template_name=None, headers=None, content_type=None)
drf的响应处理类和请求处理类不一样，Response就是django的HttpResponse响应处理类的子类。
data数据不要是render处理之后的数据，只需传递python的内建类型数据即可，REST framework会使用renderer渲染器处理data。
data不能是复杂结构的数据，如Django的模型类对象，对于这样的数据我们可以使用Serializer序列化器序列化处理后（转为了Python字典类型）再传递给data参数。
参数说明：
data: 为响应准备的序列化处理后的数据；status: 状态码，默认200；template_name: 模板名称，如果使用HTMLRenderer时需指明；headers: 用于存放响应头信息的字典；content_type: 响应数据的Content-Type，通常此参数无需传递，REST framework会根据前端所需类型数据来设置该参数。
1.1.2.2 response对象的属性
工作少用，
1）.data
传给response对象的序列化后，但尚未render处理的数据
2）.status_code
状态码的数字
3）.content
经过render处理后的响应数据
1.1.2.3 状态码
为了方便设置状态码，REST framewrok在rest_framework.status模块中提供了常用http状态码的常量。
1）信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
2）成功 - 2xx
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS
3）重定向 - 3xx
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT
4）客户端错误 - 4xx
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
5）服务器错误 - 5xx
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
为了方便演示，所以drf提供的视图里面的内容知识，我们另外创建一个子应用来展示
python manage.py startapp demo
注册子应用
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework',
'students',
'sers', # 序列化器
"school", # 序列化器嵌套
'req', # 请求与响应
'demo', # 视图
]
总路由，代码：
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('students/', include("students.urls")),
path('sers/', include("sers.urls")),
path('school/', include("school.urls")),
path("req/", include("req.urls")),
path("demo/", include("demo.urls")),
]
子应用路由，代码：
from django.urls import path
from . import views
urlpatterns = [
]
1. 视图
Django REST framwork 提供的视图的主要作用：
- 控制序列化器的执行（检验、保存、转换数据）
- 控制数据库模型的操作
1.2 普通视图
REST framework 提供了众多的通用视图基类与扩展类，以简化视图的编写。
1.2.1 2个视图基类
1.2.1.1 APIView基本视图类
rest_framework.views.APIView
APIView是REST framework提供的所有视图类的基类，继承自Django的View父类。
APIView与View的不同之处在于：
-
传入到视图方法中的是REST framework的
Request对象，而不是Django的HttpRequeset对象； -
视图方法可以返回REST framework的
Response对象，视图会为响应数据设置（renderer）符合前端期望要求的格式； -
任何
APIException异常都会被捕获到，并且处理成合适格式的响应信息返回给客户端；django 的View中所有异常全部以HTML格式显示
drf的APIVIew或者APIView的子类会自动根据客户端的Accept进行错误信息的格式转换。
-
重新声明了一个新的as_view方法并在dispatch()进行路由分发前，会对请求的客户端进行身份认证、权限检查、流量控制。
APIView除了继承了View原有的属性方法意外，还新增了类属性：
- authentication_classes 列表或元组，身份认证类
- permissoin_classes 列表或元组，权限检查类
- throttle_classes 列表或元祖，流量控制类
在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。
序列化器，demo/serializers.py，代码：
from rest_framework import serializers
from stuapi.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
extra_kwargs = {
"age": {
"max_value": 25,
"error_messages": {
"max_value": "年龄不能超过25岁！",
}
}
}
视图代码：
from rest_framework import status
from rest_framework.views import APIView
from rest_framework.response import Response
from stuapi.models import Student
from .serializers import StudentModelSerializer
"""
GET /demo/students/ 获取所有学生信息
POST /demo/students/ 添加一个学生信息
GET /demo/students/ 获取一个学生信息
PUT /demo/students/ 更新一个学生信息
DELETE /demo/students/ 删除一个学生信息
"""
# Create your views here.
class StudentAPIView(APIView):
def get(self,request):
"""获取所有学生信息"""
# 1. 从数据库中读取学生列表信息
student_list = Student.objects.all()
# 2. 实例化序列化器，获取序列化对象
serializer = StudentModelSerializer(instance=student_list, many=True)
# 3. 转换数据并返回给客户端
return Response(serializer.data)
def post(self,request):
"""添加一条数据"""
# 1. 获取客户端提交的数据，实例化序列化器，获取序列化对象
serializer = StudentModelSerializer(data=request.data)
# 2. 反序列化[验证数据、保存数据到数据库]
serializer.is_valid(raise_exception=True)
serializer.save()
# 3. 返回新增的模型数据给客户单
return Response(serializer.data, status=status.HTTP_201_CREATED)
class StudentInfoAPIView(APIView):
def get(self,request, pk):
"""获取一条数据"""
# 1. 使用pk作为条件获取模型对象
try:
student = Student.objects.get(pk=pk)
except Student.DoesNotExist:
return Response(status=status.HTTP_404_NOT_FOUND)
# 2. 序列化
serializer = StudentModelSerializer(instance=student)
# 3. 返回结果
return Response(serializer.data)
def put(self,request,pk):
"""更新数据"""
# 1. 使用pk作为条件获取模型对象
try:
student = Student.objects.get(pk=pk)
except Student.DoesNotExist:
return Response(status=status.HTTP_404_NOT_FOUND)
# 2. 获取客户端提交的数据
serializer = StudentModelSerializer(instance=student, data=request.data)
# 3. 反序列化[验证数据和数据保存]
serializer.is_valid(raise_exception=True)
serializer.save()
# 4. 返回结果
return Response(serializer.data, status=status.HTTP_201_CREATED)
def delete(self,request,pk):
"""删除数据"""
# 1. 根据PK值获取要删除的数据并删除
try:
Student.objects.get(pk=pk).delete()
except Student.DoesNotExist:
pass
# 2. 返回结果
return Response(status=status.HTTP_204_NO_CONTENT)
路由代码：
from django.urls import path, re_path
from . import views
urlpatterns = [
path("students/", views.StudentAPIView.as_view()),
re_path("^students/(?P\d+)/$" , views.StudentInfoAPIView.as_view()),
]
1.2.1.2 GenericAPIView[通用视图类]
通用视图类主要作用就是把视图中的独特的代码抽取出来，让视图方法中的代码更加通用，方便把通用代码进行简写。
rest_framework.generics.GenericAPIView
继承自APIView，主要增加了操作序列化器和数据库查询的方法，作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时，可搭配一个或多个Mixin扩展类。
提供的关于序列化器使用的属性与方法
-
属性：
- serializer_class 指明视图使用的序列化器类
-
方法：
-
get_serializer_class(self)
当出现一个视图类中调用多个序列化器时,那么可以通过条件判断在get_serializer_class方法中通过返回不同的序列化器类名就可以让视图方法执行不同的序列化器对象了。
返回序列化器类，默认返回
serializer_class，可以重写，例如：class Student2GenericAPIView(GenericAPIView): # 整个视图类只使用一个序列化器的情况 # serializer_class = StudentModelSerializert # 整个视图类中使用多个序列化器的情况 def get_serializer_class(self): if self.request.method.lower() == "put": return StudentModelSerializer else: return Student2ModelSerializer queryset = Student.objects def get(self, request, pk): """获取一个模型信息""" serializer = self.get_serializer(instance=self.get_object()) return Response(serializer.data) def put(self, request, pk): """更新一个模型信息""" serializer = self.get_serializer(instance=self.get_object(), data=request.data) serializer.is_valid(raise_exception=True) serializer.save() return Response(serializer.data) -
get_serializer(self, *args, **kwargs)
返回序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。
注意，该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。
- request 当前视图的请求对象
- view 当前请求的类视图对象
- format 当前请求期望返回的数据格式
-
提供的关于数据库查询的属性与方法
-
属性：
- queryset 指明使用的数据查询集
-
方法：
-
get_queryset(self)
返回视图使用的查询集，主要用来提供给Mixin扩展类使用，是列表视图与详情视图获取数据的基础，默认返回
queryset属性，可以重写，例如：def get_queryset(self): user = self.request.user return user.accounts.all() -
get_object(self)
返回详情视图所需的模型类数据对象，主要用来提供给Mixin扩展类使用。
在试图中可以调用该方法获取详情信息的模型类对象。
若详情访问的模型类对象不存在，会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
举例：
# url(r'^books/(?P\d+)/$', views.BookDetailView.as_view()), class BookDetailView(GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer def get(self, request, pk): book = self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象 serializer = self.get_serializer(book) return Response(serializer.data)
-
其他可以设置的属性
- pagination_class 指明分页控制类
- filter_backends 指明数据过滤控制后端
视图，代码：
"""
APIView中的api接口代码，除了部分涉及到调用模型和序列化器的代码以外，其他代码几乎都是固定写法。
所以，当我们将来针对增删查改的通用api接口编写时，完全可以基于原有的代码进行复用，
那么，drf也考虑到了这个问题，所以提供了一个GenericAPIView（通用视图类），让我们可以把接口中独特的代码单独提取出来作为属性存在。
rest_framework.generics.GenericAPIView是APIView的子类，在APIView的基础上进行属性扩展提供了2个属性，4个方法，方便我们针对通用接口进行编写。
"""
"""GenericAPIView 通用视图类"""
from rest_framework.generics import GenericAPIView
class StudentGenericAPIView(GenericAPIView):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def get(self,request):
"""获取所有数据"""
# 1. 从数据库中读取模型列表信息
queryset = self.get_queryset() # GenericAPIView提供的get_queryset
# 2. 序列化
serializer = self.get_serializer(instance=queryset, many=True)
# 3. 转换数据并返回给客户端
return Response(serializer.data)
def post(self,request):
"""添加一个数据"""
# 1. 获取客户端提交的数据，实例化序列化器，获取序列化对象
serializer = self.get_serializer(data=request.data)
# 2. 反序列化[验证数据、保存数据到数据库]
serializer.is_valid(raise_exception=True)
serializer.save()
# 3. 返回新增的模型数据给客户单
return Response(serializer.data, status=status.HTTP_201_CREATED)
class StudentInfoGenericAPIView(GenericAPIView):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def get(self,request,pk):
"""获取一个数据"""
# 1. 使用pk作为条件获取模型对象
instance = self.get_object()
# 2.序列化
serializer = self.get_serializer(instance=instance)
# 3. 返回结果
return Response(serializer.data)
def put(self, request, pk):
"""更新一个数据"""
# 1. 使用pk作为条件获取模型对象
instance = self.get_object()
# 2. 获取客户端提交的数据
serializer = self.get_serializer(instance=instance, data=request.data)
# 3. 反序列化[验证数据和数据保存]
serializer.is_valid(raise_exception=True)
serializer.save()
# 4. 返回结果
return Response(serializer.data, status=status.HTTP_201_CREATED)
def delete(self,request,pk):
"""删除一个数据"""
# 1. 根据PK值获取要删除的数据并删除
self.get_object().delete()
# 2. 返回结果
return Response(status=status.HTTP_204_NO_CONTENT)
序列化器类：
from rest_framework import serializers
from stuapi.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
extra_kwargs = {
"age": {
"max_value": 25,
"error_messages": {
"max_value": "年龄不能超过25岁！",
}
}
}
路由代码：
from django.urls import path, re_path
from . import views
urlpatterns = [
# APIView
path("students/", views.StudentAPIView.as_view()),
re_path("^students/(?P\d+)/$" , views.StudentInfoAPIView.as_view()),
# GenericAPIView
path("students2/", views.StudentGenericAPIView.as_view()),
re_path("^students2/(?P\d+)/$" , views.StudentInfoGenericAPIView.as_view()),
]
1.2.2 5个视图扩展类
也叫混入类。
作用：
提供了几种后端视图（对数据资源进行增删改查）处理流程的实现，如果需要编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。
这五个扩展类需要搭配GenericAPIView通用视图基类，因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法。
1）ListModelMixin
列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。
该Mixin的list方法会对数据进行过滤和分页。
源代码：
class ListModelMixin(object):
"""
List a queryset.
"""
def list(self, request, *args, **kwargs):
# 过滤
queryset = self.filter_queryset(self.get_queryset())
# 分页
page = self.paginate_queryset(queryset)
if page is not None:
serializer = self.get_serializer(page, many=True)
return self.get_paginated_response(serializer.data)
# 序列化
serializer = self.get_serializer(queryset, many=True)
return Response(serializer.data)
举例：
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class StudentMixinAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
serializer_class = StudentModelSerializer
queryset = Student.objects
def get(self,request,*args,**kwargs):
"""获取所有模型信息"""
return self.list(request,*args,**kwargs)
2）CreateModelMixin
创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。
如果序列化器对前端发送的数据验证失败，返回400错误。
源代码：
class CreateModelMixin(object):
"""
Create a model instance.
"""
def create(self, request, *args, **kwargs):
# 获取序列化器
serializer = self.get_serializer(data=request.data)
# 验证
serializer.is_valid(raise_exception=True)
# 保存
self.perform_create(serializer)
headers = self.get_success_headers(serializer.data)
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
def perform_create(self, serializer):
serializer.save()
def get_success_headers(self, data):
try:
return {'Location': str(data[api_settings.URL_FIELD_NAME])}
except (TypeError, KeyError):
return {}
视图代码：
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class StudentMixinAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
serializer_class = StudentModelSerializer
queryset = Student.objects
def get(self,request,*args,**kwargs):
"""获取所有模型信息"""
return self.list(request,*args,**kwargs)
def post(self,request):
"""添加一个模型信息"""
return self.create(request)
3）RetrieveModelMixin
详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。
如果存在，返回200， 否则返回404。
源代码：
class RetrieveModelMixin(object):
"""
Retrieve a model instance.
"""
def retrieve(self, request, *args, **kwargs):
# 获取对象，会检查对象的权限
instance = self.get_object()
# 序列化
serializer = self.get_serializer(instance)
return Response(serializer.data)
视图代码：
from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student1MixinAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
serializer_class = StudentModelSerializer
queryset = Student.objects
def get(self,request,pk):
"""获取一个模型信息"""
return self.retrieve(request,pk)
4）UpdateModelMixin
更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。
同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。
成功返回200，序列化器校验数据失败时，返回400错误。
源代码：
class UpdateModelMixin(object):
"""
Update a model instance.
"""
def update(self, request, *args, **kwargs):
partial = kwargs.pop('partial', False)
instance = self.get_object()
serializer = self.get_serializer(instance, data=request.data, partial=partial)
serializer.is_valid(raise_exception=True)
self.perform_update(serializer)
if getattr(instance, '_prefetched_objects_cache', None):
# If 'prefetch_related' has been applied to a queryset, we need to
# forcibly invalidate the prefetch cache on the instance.
instance._prefetched_objects_cache = {}
return Response(serializer.data)
def perform_update(self, serializer):
serializer.save()
def partial_update(self, request, *args, **kwargs):
kwargs['partial'] = True
return self.update(request, *args, **kwargs)
视图代码：
from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student1MixinAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
serializer_class = StudentModelSerializer
queryset = Student.objects
def get(self,request,pk):
"""获取一个模型信息"""
return self.retrieve(request,pk)
def put(self,request,pk):
"""更新一个模型信息"""
return self.update(request,pk)
5）DestroyModelMixin
删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。
成功返回204，不存在返回404。
源代码：
class DestroyModelMixin(object):
"""
Destroy a model instance.
"""
def destroy(self, request, *args, **kwargs):
instance = self.get_object()
self.perform_destroy(instance)
return Response(status=status.HTTP_204_NO_CONTENT)
def perform_destroy(self, instance):
instance.delete()
视图代码：
from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student1MixinAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
serializer_class = StudentModelSerializer
queryset = Student.objects
def get(self,request,pk):
"""获取一个模型信息"""
return self.retrieve(request,pk)
def put(self,request,pk):
"""更新一个模型信息"""
return self.update(request,pk)
def delete(self,request,pk):
"""删除一个模型信息"""
return self.destroy(request,pk)
整体代码，使用GenericAPIView结合视图扩展类，实现5个基本api接口，视图代码：
"""
使用drf内置的模型扩展类[混入类]结合GenericAPIView实现通用视图方法的简写操作
from rest_framework.mixins import ListModelMixin 获取多条数据，返回响应结果 list
from rest_framework.mixins import CreateModelMixin 添加一条数据，返回响应结果 create
from rest_framework.mixins import RetrieveModelMixin 获取一条数据，返回响应结果 retrieve
from rest_framework.mixins import UpdateModelMixin 更新一条数据，返回响应结果 update(更新全部字段)和partial_update(更新单个或部分字段，例如修改密码，修改头像)
from rest_framework.mixins import DestroyModelMixin 删除一条数据，返回响应结果 destroy
"""
from rest_framework.mixins import ListModelMixin, CreateModelMixin
class StudentMixinView(GenericAPIView, ListModelMixin, CreateModelMixin):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def get(self,request):
"""获取所有数据"""
return self.list(request)
def post(self,request):
"""添加一条数据"""
return self.create(request)
from rest_framework.mixins import RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin
class StudentInfoMixinView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def get(self,request,pk):
return self.retrieve(request, pk=pk)
def put(self,request, pk):
return self.update(request, pk=pk)
def delete(self,request, pk):
return self.destroy(request, pk=pk)
序列化器，代码：
from rest_framework import serializers
from stuapi.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
extra_kwargs = {
"age": {
"max_value": 25,
"error_messages": {
"max_value": "年龄不能超过25岁！",
}
}
}
路由代码：
from django.urls import path, re_path
from . import views
urlpatterns = [
# APIView
path("students/", views.StudentAPIView.as_view()),
re_path("^students/(?P\d+)/$" , views.StudentInfoAPIView.as_view()),
# GenericAPIView
path("students2/", views.StudentGenericAPIView.as_view()),
re_path("^students2/(?P\d+)/$" , views.StudentInfoGenericAPIView.as_view()),
# GenericAPIView + mixins
path("students3/", views.StudentMixinView.as_view()),
re_path("^students3/(?P\d+)/$" , views.StudentInfoMixinView.as_view()),
]
1.2.3 9个视图子类
1）CreateAPIView
提供了post方法，内部调用了create方法
继承自： GenericAPIView、CreateModelMixin
2）ListAPIView
提供了get方法，内部调用了list方法
继承自：GenericAPIView、ListModelMixin
3）RetrieveAPIView
提供了get方法，内部调用了retrieve方法
继承自: GenericAPIView、RetrieveModelMixin
4）DestoryAPIView
提供了delete方法，内部调用了destory方法
继承自：GenericAPIView、DestoryModelMixin
5）UpdateAPIView
提供了put和patch方法，内部调用了update和partial_update方法
继承自：GenericAPIView、UpdateModelMixin
6）ListCreateAPIView
提供了get和post方法，内部调用了list和create方法
继承自：GenericAPIView、ListModelMixin、CreateModelMixin
7）RetrieveUpdateAPIView
提供 get、put、patch方法
继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin
8）RetrieveDestoryAPIView
提供 get、delete方法
继承自：GenericAPIView、RetrieveModelMixin、DestoryModelMixin
9）RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法
继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin
视图代码：
"""
上面的接口代码还可以继续更加的精简，drf在使用GenericAPIView和Mixins进行组合以后，还提供了视图子类。
视图子类，提供了各种的视图方法调用mixins操作
ListAPIView = GenericAPIView + ListModelMixin 获取多条数据的视图方法
CreateAPIView = GenericAPIView + CreateModelMixin 添加一条数据的视图方法
RetrieveAPIView = GenericAPIView + RetrieveModelMixin 获取一条数据的视图方法
UpdateAPIView = GenericAPIView + UpdateModelMixin 更新一条数据的视图方法
DestroyAPIView = GenericAPIView + DestroyModelMixin 删除一条数据的视图方法
组合视图子类
ListCreateAPIView = ListAPIView + CreateAPIView
RetrieveUpdateAPIView = RetrieveAPIView + UpdateAPIView
RetrieveDestroyAPIView = RetrieveAPIView + DestroyAPIView
RetrieveUpdateDestroyAPIView = RetrieveAPIView + UpdateAPIView + DestroyAPIView
"""
# from rest_framework.generics import ListAPIView, CreateAPIView
from rest_framework.generics import ListCreateAPIView
class StudentListAPIView(ListCreateAPIView):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
# from rest_framework.generics import RetrieveAPIView, UpdateAPIView, DestroyAPIView
# from rest_framework.generics import RetrieveUpdateAPIView, DestroyAPIView
# from rest_framework.generics import RetrieveDestroyAPIView, UpdateAPIView
from rest_framework.generics import RetrieveUpdateDestroyAPIView # 四行代码一样意思
class StudentInfoAPIView(RetrieveUpdateDestroyAPIView):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
序列化器，代码：
from rest_framework import serializers
from school.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
路由，代码：
from django.urls import path
from . import views
urlpatterns = [
path("s1/", views.StudentList1APIView.as_view()),
path("s1//" , views.StudentInfo1APIView.as_view()),
path("s2/", views.StudentList2GenericAPIView.as_view()),
path("s2//" , views.StudentInfo2GenericAPIView.as_view()),
path("s3/", views.StudentList3GenericAPIView.as_view()),
path("s3//" , views.StudentInfo3GenericAPIView.as_view()),
path("s4/", views.StudentListAPIView.as_view()),
path("s4//" , views.StudentInfoAPIView.as_view()),
]
1.3 视图集ViewSet
使用视图集ViewSet，可以将一系列视图相关的代码逻辑和相关的http请求动作封装到一个类中：
- list() 提供一组数据
- retrieve() 提供单个数据
- create() 创建数据
- update() 保存数据
- destory() 删除数据
ViewSet视图集类不再限制视图方法名只允许get()、post()等这种情况了，而是实现允许开发者根据自己的需要定义自定义方法名，例如 list() 、create() 等，然后经过路由中使用http和这些视图方法名进行绑定调用。
视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。如：
"""
针对视图子类这种写法写法虽然已经省略了http请求，但是在开发通用5个api接口时，还是会出现需要2个类来实现5个接口的情况。
这主要的原因是2点：
1. 获取多条数据与获取一条数据的http请求重复了。在django中依赖于请求方法来响应不同的http请求
2. 部分接口需要pk值作为url地址。
drf为了解决上面的2个问题，提供了视图集和路由集。
视图集就可以帮我们实现一个视图类响应多种重复的http请求
路由集就可以帮我们实现自动根据不同的视图方法来生成不同参数的路由地址。
from rest_framework.viewsets import ViewSet # ViewSet是APIView的子类，是所有drf中的视图集的父类
"""
from rest_framework.viewsets import ViewSet
class StudentViewSet(ViewSet):
# ViewSet不再需要我们使用http请求作为视图方法了。当然，如果你还希望使用http作为视图方法也可以。
def get_all(self,request):
queryset = Student.objects.all()
# 实例化序列化器对象
serializer = StudentModelSerializer(instance=queryset, many=True)
# 返回序列化后的数据列表
return Response(serializer.data)
def create(self,request):
"""添加一条数据"""
# 接收客户端提交的数据
# 1. 实例化序列化器对象，获取来自客户端的请求数据作为参数
serializer = StudentModelSerializer(data=request.data)
# 2. 反序列化, 调用is_valid进行数据校验
serializer.is_valid(raise_exception=True)
# 3. 反序列化, 调用save保存数据
serializer.save()
# 4. 序列化，把新增后的模型对象返回给客户端
return Response(serializer.data, status=status.HTTP_201_CREATED)
def get_one(self,request,pk):
try:
# 模型操作，根据pk值获取指定数据
instance = Student.objects.get(pk=pk)
# 实例化序列化器对象
serializer = StudentModelSerializer(instance=instance)
# 返回序列化后的数据
return Response(serializer.data)
except Student.DoesNotExist:
return Response({"msg":"当前学生不存在！"}, status=status.HTTP_404_NOT_FOUND)
def put(self,request,pk):
"""更新一条数据"""
try:
# 获取要更新的模型对象
instance = Student.objects.get(pk=pk)
# 实例化序列化器对象，参数分别是本次更新的模型对象以及接受来自客户端提交的更新数据
serializer = StudentModelSerializer(instance=instance, data=request.data)
# 反序列化，验证数据
serializer.is_valid(raise_exception=True)
# 反序列化器，保存数据
serializer.save()
# 序列化，返回更新后的数据
return Response(serializer.data)
except Student.DoesNotExist:
return Response({"msg": "当前学生不存在！"}, status=status.HTTP_404_NOT_FOUND)
def delete(self,request,pk):
"""删除一条数据"""
try:
# 获取要更新的模型对象
student = Student.objects.get(pk=pk)
student.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
except Student.DoesNotExist:
return Response({"msg": "当前学生不存在！"}, status=status.HTTP_404_NOT_FOUND)
在设置路由时，我们可以如下操作
from django.urls import path
from . import views
urlpatterns = [
path("s1/", views.StudentList1APIView.as_view()),
path("s1//" , views.StudentInfo1APIView.as_view()),
path("s2/", views.StudentList2GenericAPIView.as_view()),
path("s2//" , views.StudentInfo2GenericAPIView.as_view()),
path("s3/", views.StudentList3GenericAPIView.as_view()),
path("s3//" , views.StudentInfo3GenericAPIView.as_view()),
path("s4/", views.StudentListAPIView.as_view()),
path("s4//" , views.StudentInfoAPIView.as_view()),
path("s5/", views.StudentViewSet.as_view(actions={"get":"get_all","post":"create"})),
path("s5//" , views.StudentViewSet.as_view({"get":"get_one","put":"put","delete":"delete"})),
]
1.3.1 常用视图集父类
1） ViewSet
继承自APIView与ViewSetMixin，作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等。
ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典{“http请求”：“视图方法”}的映射处理工作，如{‘get’:‘list’}，
在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法。
2）GenericViewSet
继承自GenericAPIView和ViewSetMixin，作用让视图集的视图代码变得更加通用，抽离独特代码作为视图类的属性。
使用ViewSet通常并不方便，因为list、retrieve、create、update、destory等方法都需要自己编写，而这些方法与前面讲过的Mixin扩展类提供的方法同名，所以我们可以通过继承Mixin扩展类来复用这些方法而无需自己编写。但是Mixin扩展类依赖与GenericAPIView，所以还需要继承GenericAPIView。
GenericViewSet就帮助我们完成了这样的继承工作，继承自GenericAPIView与ViewSetMixin，在实现了调用as_view()时传入字典（如{'get':'list'}）的映射处理工作的同时，还提供了GenericAPIView提供的基础方法，可以直接搭配Mixin扩展类使用。
视图代码：
from rest_framework.viewsets import GenericViewSet
class StudentGenericViewSet(GenericViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def list(self,request):
"""获取多条数据"""
# 获取模型对象列表，实例化序列化器对象
serializer = self.get_serializer(instance=self.get_queryset(), many=True)
# 返回序列化后的数据列表
return Response(serializer.data)
def post(self,request):
"""添加一条数据"""
serializer = self.get_serializer(data=request.data)
# 2. 反序列化, 调用is_valid进行数据校验
serializer.is_valid(raise_exception=True)
# 3. 反序列化, 调用save保存数据
serializer.save()
# 4. 序列化，把新增后的模型对象返回给客户端
return Response(serializer.data, status=status.HTTP_201_CREATED)
def retrieve(self, request, pk):
"""获取一条数据"""
# 模型操作，根据pk值获取指定数据
instance = self.get_object() # 上面代码的简写，而且对错误进行格式处理
# 实例化序列化器对象
serializer = self.get_serializer(instance=instance)
# 返回序列化后的数据列表
return Response(serializer.data)
def update(self, request, pk):
"""更新一条数据"""
instance = self.get_object() # 不要漏了pk参数
serializer = self.get_serializer(instance=instance, data=request.data)
# 反序列化，验证数据
serializer.is_valid(raise_exception=True)
# 反序列化器，保存数据
serializer.save()
# 序列化，返回更新后的数据
return Response(serializer.data)
def delete(self, request, pk):
instance = self.get_object()
instance.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
路由代码：
from django.urls import path
from . import views
urlpatterns = [
path("s1/", views.StudentList1APIView.as_view()),
path("s1//" , views.StudentInfo1APIView.as_view()),
path("s2/", views.StudentList2GenericAPIView.as_view()),
path("s2//" , views.StudentInfo2GenericAPIView.as_view()),
path("s3/", views.StudentList3GenericAPIView.as_view()),
path("s3//" , views.StudentInfo3GenericAPIView.as_view()),
path("s4/", views.StudentListAPIView.as_view()),
path("s4//" , views.StudentInfoAPIView.as_view()),
# path("url地址/", views.StudentViewSet.as_view({"http请求方法名":"视图方法名","http请求方法名":"视图方法名",....})),
path("s5/", views.StudentViewSet.as_view({"get":"get_all","post":"create"})),
path("s5//" , views.StudentViewSet.as_view({"get":"get_one","put":"put","delete":"delete"})),
path("s6/", views.StudentGenericViewSet.as_view({"get":"list","post":"post"})),
path("s6//" , views.StudentGenericViewSet.as_view({"get":"retrieve","put":"update","delete":"delete"})),
]
集合我们上面学习的模型扩展类，实现简写操作，视图，代码：
"""
GenericViewSet结合Mixins的混入类，直接视图接口，这次连视图子类都不需要了。
ViewSet
GenericViewSet
ModelViewSet = GenericViewSet + ListModelMixin + CreateModelMixin + UpdateModelMixin + RetrieveModelMixin + DestroyModelMixin
ReadOnlyModelViewSet = GenericViewSet + ListModelMixin + RetrieveModelMixin
"""
from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin, CreateModelMixin, UpdateModelMixin, RetrieveModelMixin, DestroyModelMixin
class StudentMixinViewSet(GenericViewSet, ListModelMixin, CreateModelMixin, UpdateModelMixin, RetrieveModelMixin, DestroyModelMixin):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
路由，代码：
from django.urls import path
from . import views
urlpatterns = [
path("s1/", views.StudentList1APIView.as_view()),
path("s1//" , views.StudentInfo1APIView.as_view()),
path("s2/", views.StudentList2GenericAPIView.as_view()),
path("s2//" , views.StudentInfo2GenericAPIView.as_view()),
path("s3/", views.StudentList3GenericAPIView.as_view()),
path("s3//" , views.StudentInfo3GenericAPIView.as_view()),
path("s4/", views.StudentListAPIView.as_view()),
path("s4//" , views.StudentInfoAPIView.as_view()),
# path("url地址/", views.StudentViewSet.as_view({"http请求方法名":"视图方法名","http请求方法名":"视图方法名",....})),
path("s5/", views.StudentViewSet.as_view({"get":"get_all","post":"create"})),
path("s5//" , views.StudentViewSet.as_view({"get":"get_one","put":"put","delete":"delete"})),
path("s6/", views.StudentGenericViewSet.as_view({"get":"list","post":"post"})),
path("s6//" , views.StudentGenericViewSet.as_view({"get":"retrieve","put":"update","delete":"delete"})),
path("s7/", views.StudentMixinViewSet.as_view({"get":"list","post":"create"})),
path("s7//" , views.StudentMixinViewSet.as_view({"get":"retrieve","put":"update","delete":"destroy"})),
]
3）ModelViewSet
继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
4）ReadOnlyModelViewSet
继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin。
视图代码：
"""
GenericViewSet结合Mixins的混入类，直接视图接口，这次连视图子类都不需要了。
ViewSet
GenericViewSet
ModelViewSet = GenericViewSet + ListModelMixin + CreateModelMixin + UpdateModelMixin + RetrieveModelMixin + DestroyModelMixin
ReadOnlyModelViewSet = GenericViewSet + ListModelMixin + RetrieveModelMixin
"""
from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin, CreateModelMixin, UpdateModelMixin, RetrieveModelMixin, DestroyModelMixin
from rest_framework.viewsets import ModelViewSet # 万能视图集，5个接口的简写
from rest_framework.viewsets import ReadOnlyModelViewSet # 只读视图集，2个接口的简写
class StudentMixinViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
路由代码：
from django.urls import path
from . import views
urlpatterns = [
path("s1/", views.StudentList1APIView.as_view()),
path("s1//" , views.StudentInfo1APIView.as_view()),
path("s2/", views.StudentList2GenericAPIView.as_view()),
path("s2//" , views.StudentInfo2GenericAPIView.as_view()),
path("s3/", views.StudentList3GenericAPIView.as_view()),
path("s3//" , views.StudentInfo3GenericAPIView.as_view()),
path("s4/", views.StudentListAPIView.as_view()),
path("s4//" , views.StudentInfoAPIView.as_view()),
# path("url地址/", views.StudentViewSet.as_view({"http请求方法名":"视图方法名","http请求方法名":"视图方法名",....})),
path("s5/", views.StudentViewSet.as_view({"get":"get_all","post":"create"})),
path("s5//" , views.StudentViewSet.as_view({"get":"get_one","put":"put","delete":"delete"})),
path("s6/", views.StudentGenericViewSet.as_view({"get":"list","post":"post"})),
path("s6//" , views.StudentGenericViewSet.as_view({"get":"retrieve","put":"update","delete":"delete"})),
path("s7/", views.StudentMixinViewSet.as_view({"get":"list","post":"create"})),
path("s7//" , views.StudentMixinViewSet.as_view({"get":"retrieve","put":"update","delete":"destroy"})),
]
2. 路由Routers
对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。如果是非视图集，不需要使用路由集routers
REST framework提供了两个router，使用方式一致的。结果多一个或少一个根目录url地址的问题而已。
- SimpleRouter
- DefaultRouter
2.1 使用方法
1） 创建router对象，并注册视图集，例如
from django.urls import path
from . import views
urlpatterns = [
# 省略....
# path("s7/", views.StudentMixinViewSet.as_view({"get":"list","post":"create"})),
# path("s7//", views.StudentMixinViewSet.as_view({"get":"retrieve","put":"update","delete":"destroy"})),
]
# 路由集的操作
from rest_framework.routers import DefaultRouter,SimpleRouter
router = DefaultRouter()
# 注册视图(访问前缀，视图集类，调用别名)
router.register("s7", views.StudentMixinViewSet, "s7")
# 把路由对象生成的视图集路由列表合并追加路由列表中
print(router.urls)
urlpatterns += router.urls
register(prefix, viewset, basename)
- prefix 该视图集的路由前缀
- viewset 视图集
- basename 路由别名的前缀
如上述代码会形成的路由如下：
url: ^s7/$ basename: s7-list
url: ^s7/(?P<pk>[^/.]+)/$ basename: s7-detail
2）把路由对象生成的视图集的路由列表添加到django的路由中可以有两种方式：
urlpatterns = [
...
]
urlpatterns += router.urls
或
from django.urls import include,re_path
urlpatterns = [
...
re_path('^', include(router.urls))
]
2.2 视图集中附加action的声明
在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用rest_framework.decorators.action装饰器。
以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。
action装饰器可以接收两个参数：
-
methods: 声明该action对应的请求方式，列表传递
-
detail: 声明该action的路径是否与单一资源对应
路由前缀//action方法名/ - True 表示路径格式是
xxx//action方法名/ - False 表示路径格式是
xxx/action方法名/
- True 表示路径格式是
-
url_path：声明该action的路由尾缀。
举例：
from rest_framework.viewsets import ModelViewSet # 万能视图集，5个接口的简写
from rest_framework.viewsets import ReadOnlyModelViewSet # 只读视图集，2个接口的简写
from rest_framework.decorators import action
class StudentMixinViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
# 路由对象给视图集生成路由信息时，只会生成5个基本api接口，这主要是router只识别5个混入类的原因，
# 而针对我们开发者自定义的视图方法，路由对象不会自动生成路由信息，
# 所以下面这个login，如果希望被外界访问到，则必须通过action装饰器告诉路由对象要给它生成一个路由信息。
@action(methods=["get","post"], detail=False, url_path="login")
# action的参数
# methods, 列表，指定允许哪些http请求方法可以访问当前视图方法
# detail, 布尔值，告诉路由对象在生成路由信息时，是否要自动生成pk值，True表示需要，False表示不需要。
# url_path，字符串，访问视图的url地址，如果不设置，则默认采用视图方法名作为访问后缀
# http://127.0.0.1:8000/demo/s7/login/
def login(self, request):
"""登录视图"""
return Response({"msg":"登录成功"})
@action(methods=["get"], detail=True, url_path="login/log")
# http://127.0.0.1:8000/demo/s7/23/login/log/
def login_log(self,request,pk):
"""用户登录历史记录"""
# 视图集类中
# 可以通过self.method获取本次客户端的http请求
# 可以通过self.action获取本次客户端请求的视图方法名[ViewSet提供的]
print(self.action) # login_log
return Response({"msg": "用户登录历史记录"})
由路由器自动为此视图集自定义action方法形成的路由会是如下内容：
url: ^s7/login/$ basename: s7-login
url: ^s7/(?P<pk>[^/.]+)/login/log/$ basename: s7-login-log
2.3 路由router形成URL的方式
1） SimpleRouter（prefix=“路由前缀”，viewset=视图集类，basename=“路由别名”）
2）DefaultRouter
DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。