路由Routers

對於視圖集ViewSet，我們除了可以自己手動指明請求方式與動作action之間的對應關系外，還可以使用Routers來幫助我們快速實現路由信息。

REST framework提供了兩個router

• SimpleRouter
• DefaultRouter

1. 使用方法

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))

]

2. 視圖集中包含附加action的

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):


queryset = BookInfo.objects.all()

serializer_class = BookInfoSerializer

@action(methods=[‘get‘], detail=False)


def latest(self, request):


...


@action(methods=[‘put‘], detail=True)


def read(self, request, pk):


...

此視圖集會形成的路由：

 
^books/latest/$ name: book-latest


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

3. 路由router形成URL的方式

1） SimpleRouter

2）DefaultRouter

DefaultRouter與SimpleRouter的區別是，DefaultRouter會多附帶一個默認的API根視圖，返回一個包含所有列表視圖的超鏈接響應數據。

Django-路由Routers-SimpleRouter-DefaultRouter使用方法