一 路由Routers
对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。
REST framework提供了两个router
- SimpleRouter
- DefaultRouter
1.1 使用方法
1） 创建router对象，并注册视图集，例如
1
2
3
4
|
from rest_framework import routers
router = routers.SimpleRouter()
router.register(r‘router_stu‘, StudentModelViewSet, base_name=‘student‘)
|
register(prefix, viewset, base_name)
- prefix 该视图集的路由前缀
- viewset 视图集
- base_name 路由别名的前缀
如上述代码会形成的路由如下：
1
2
|
^books/$ name: book-list
^books/{pk}/$ name: book-detail
|
2）添加路由数据
可以有两种方式：
1
2
3
4
|
urlpatterns = [
...
]
urlpatterns += router.urls
|
或
1
2
3
4
|
urlpatterns = [
...
url(r‘^‘, include(router.urls))
]
|
1.2 代码演示
使用路由类给视图集生成了路由地址
1
2
3
4
5
6
7
8
9
10
|
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
classStudentModelViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
deflogin(self,request):
"""学生登录功能"""
print(self.action)
return Response({"message":"登录成功"})
|
路由代码：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
from django.urls import path, re_path
from . import views
urlpatterns = [
...
]
"""使用drf提供路由类router给视图集生成路由列表"""
|
上面的代码就成功生成了路由地址[增/删/改/查一条/查多条的功能]，但是不会自动我们在视图集自定义方法的路由。
所以我们如果也要给自定义方法生成路由，则需要进行action动作的声明。
1.2 视图集中附加action的声明
在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用rest_framework.decorators.action装饰器。
以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。
action装饰器可以接收两个参数：
举例：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action
class StudentModelViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
|
由路由器自动为此视图集自定义action方法形成的路由会是如下内容：
1
2
|
^router_stu/get_new_5/$ name: router_stu-get_new_5
^router_stu/{pk}/login/$ name: router_stu-login
|
1.3 路由router形成URL的方式
1） SimpleRouter
2）DefaultRouter
DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。
drf 之路由
原文：https://www.cnblogs.com/liqiangwei/p/14201054.html
