Router提供了一种简单,快速,集成的方式来定义一系列的urls
例子:
from rest_framework import routers
router = routers.SimpleRouter()
router.register('users', UserViewSet)
router.register('account', AccountViewSet)
urlpatterns = router.ulrs
register()函数有两个必要参数:
prefix: 字首,用来表示一系列的urls
viewset: viewset class
可选的参数:
base_name: 用来生成urls名字,如果viewset中没有包含queryset, base_name一定要有
上面的例子生成的url:
URL pattern: ^users/$ Name: 'user-list'
URL pattern: ^users/{pk}/$ Name: 'user-detail'
URL pattern: ^accounts/$ Name: 'account-list'
URL pattern: ^accounts/{pk}/$ Name: 'account-detail'
----------------------------------------------------------------------------------
在routers中使用include
routers实例的urls属性表示一系列的urls.可以通过不同的方式来包含其他的urls
from rest_framework import routers
router = routers.DefaultRouter()
router.register('users', UserViewSet)
router.register('accounts', AccountViewSet)
urlpatters = pattern(
url('^forget_password/$', ForgetPasswordViewSet.as_view())
)
urlpatterns += router.urls
你也可以使用include:
from rest_framework import routers
router = routers.DefaultRouter()
router.register('users', UserViewSet)
router.register('accounts', AccountViewSet)
urlpatters = pattern(
url('^forget_password/$', ForgetPasswordViewSet.as_view())
url('^', include(router.urls))
)
---------------------------------------------------------------------------------
额外的连接和操作
viewset定义了list, update, retrieve, create, update, destory, partial_update方法, 如果你有一些额外的操作,可以使用@detail_route 或者 @list_route来实现
from rest_framework.decorators import detail_route
class UserViewSet(ModelViewSet):
@detail_route(methods=['POST'])
def set_password(self, request, pk=None):
pass
它对应的url为: /users/{pk}/set_password Name: user-set-password
如果你不想使用默认的url,你可以通过设置url_path参数来改变url
from rest_framework.decorators import detail_route
class UserViewSet(ModelViewSet):
@detail_route(methods=['POST'], url_path='change-password')
def set_password(self, request, pk=None):
pass
urlpattern: /users/{pk}/change-password/$ Name: user-change-password