DRF的路由生成类的使用

DRF路由生成类的使用

对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。

REST framework提供了两个router

• SimpleRouter

• DefaultRouter

使用方法：

1） 创建router对象，并注册视图集，例如

from rest_framework import routers

router = routers.SimpleRouter()
router.register(r'books', BookInfoViewSet, base_name='book')

register(prefix, viewset, base_name)

• prefix 该视图集的路由前缀

• viewset 视图集

• base_name 路由名称的前缀

如上述代码会形成的路由如下：

^books/$    name: book-list
^books/{pk}/$   name: book-detail

2）添加路由数据

可以有两种方式：
urlpatterns = [
    ...
]
urlpatterns += router.urls
或
urlpatterns = [
    ...
    url(r'^', include(router.urls))
]

在views.py中操作完视图函数后，路由我们可以用drf中自带的路由类，route，

它或会帮助我们将视图函数的增删改查都自动生成

from rest_framework.routers import DefaultRouter

案例说明：

serializers.py

# 创建一个Bookinfo 序列化器
from rest_framework import serializers
from .models import BookInfo

class BookInfoSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = '__all__'

views.py

from django.shortcuts import render

# Create your views here.
from rest_framework.viewsets import ModelViewSet
from .serializers import BookInfoSerializer
from .models import BookInfo

class BookInfoViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

urls.py

from . import views

from rest_framework.routers import DefaultRouter

urlpatterns = [

]

route = DefaultRouter()
# route.register("路由地址的前缀", 视图集类) # 
route.register(r"books", views.BookInfoViewSet) # 

urlpatterns += route.urls

DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。

api根视图

另外附加说明：视图集中附加action的声明

上面的route路由自动会产生增删改查的路由，但是如果我要访问自定义的那个视图函数，它是不会自动产生的

比如在views.py 文件中创建了一个查询  这个图书的前五名阅读量的视图函数，但是route类并没有给我产生，我该怎么办呢？

这个时候就用到了附加action的的申明

在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用rest_framework.decorators.action装饰器。

以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。

action装饰器可以接收两个参数：

• methods: 声明该action对应的请求方式，列表传递

• detail

  : 声明该action的路径是否与单一资源对应，及是否是

• xxx/<pk>/action方法名/

• True 表示路径格式是xxx/<pk>/action方法名/

• False 表示路径格式是xxx/action方法名/

 

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    # detail为False 表示路径名格式应该为 books/latest/
    @action(methods=['get'], detail=False)
    def latest(self, request):
        """
        返回最新的图书信息
        """
        ...

    # detail为True，表示路径名格式应该为 books/{pk}/read/
    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        """
        修改图书的阅读量数据
        """
        ...

由路由器自动为此视图集自定义action方法形成的路由会是如下内容：

^books/latest/$    name: book-latest
^books/{pk}/read/$  name: book-read