Django-Rest-Framework 教程: 6. ViewSets 和 Routers

django-rst-framework为咱们提供了ViewSet类, ViewSet为咱们提供了默认的URL结构, 使得咱们能更专一于API自己. ViewSet类与View类几乎是相同的, 但提供的是read或update, 而不是http动做get或put.

ViewSet类在实例化后, 经过Router类, 最终将URL与ViewSet方法绑定. 接下来咱们使用ViewSet代替以前的View.

1. 使用ViewSet

将UserList和UserDetail移除, 并替换为UserViewSet:

    # snippets/views.py
    class UserViewSet(viewsets.ReadOnlyModelViewSet): """ 这一viewset提供了`list`和`detail` """ queryset = User.objects.all() serializer_class = UserSerializer

咱们使用ReadOnlyModelViewSet提供默认的只读权限, queryset和serializer_class设置仍是未变.

将SnippetList, SnippetDetail和SnippetHighlight移除, 替换为SnippetViewSet:

    # snippets/views.py
    from rest_framework.decorators import link class SnippetViewSet(viewsets.ModelViewSet): """ 这一viewset提供了`list`, `create`, `retrieve`, `update` 和 `destroy` 但咱们须要本身设置 `highlight`. """ queryset = Snippet.objects.all() serializer_class = SnippetSerializer permission_classes = (permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly,) @link(renderer_classes=[renderers.StaticHTMLRenderer]) def highlight(self, request, *args, **kwargs): snippet = self.get_object() return Response(snippet.highlighted) def pre_save(self, obj): obj.owner = self.request.user

咱们使用ModelViewSet类实现读写操做API. 咱们使用了@link修饰器来建立自定义的highlight动做, 这一修饰器能够用于建立非标准路径. @link修饰器对应的是get request, 若是想对应post request, 可使用@action修饰器.

2. 明确关联URL

为了更清楚ViewSet内部发生的事情, 咱们首先在urls.py中使用明确指明的关联:

    # snippets/urls.py
    from snippets.views import SnippetViewSet, UserViewSet from rest_framework import renderers snippet_list = SnippetViewSet.as_view({ 'get': 'list', 'post': 'create' }) snippet_detail = SnippetViewSet.as_view({ 'get': 'retrieve', 'put': 'update', 'patch': 'partial_update', 'delete': 'destroy' }) snippet_highlight = SnippetViewSet.as_view({ 'get': 'highlight' }, renderer_classes=[renderers.StaticHTMLRenderer]) user_list = UserViewSet.as_view({ 'get': 'list' }) user_detail = UserViewSet.as_view({ 'get': 'retrieve' }) urlpatterns = format_suffix_patterns(patterns('snippets.views', url(r'^$', 'api_root'), url(r'^snippets/$', snippet_list, name='snippet-list'), url(r'^snippets/(?P<pk>[0-9]+)/$', snippet_detail, name='snippet-detail'), url(r'^snippets/(?P<pk>[0-9]+)/highlight/$', snippet_highlight, name='snippet-highlight'), url(r'^users/$', user_list, name='user-list'), url(r'^users/(?P<pk>[0-9]+)/$', user_detail, name='user-detail') ))

3. 使用Router类自动关联URL

Router类能够轻松的帮咱们实现URL和ViewSet之间的关联, 咱们先注释掉snippets/urls.py中全部内容, 而后从新改写tutorial/urls.py:

    # tutorial/urls.py
    from django.conf.urls import patterns, url, include from snippets import views from rest_framework.routers import DefaultRouter # 黄建router并注册viewset. router = DefaultRouter() router.register(r'snippets', views.SnippetViewSet) router.register(r'users', views.UserViewSet) # router会自动生成url # 咱们只须要额外提供可浏览性登入API urlpatterns = patterns('', url(r'^', include(router.urls)), url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) )

4. View类和ViewSet类

使用ViewSet类为咱们提供了统一的URL地址, 减小了代码的量, 是咱们更专一于API自己.

但这不表明必定要使用ViewSet类, ViewSet相对于View更为不明确. 因此在使用中须要特别注意

5. 测试

接下来可使用以前的方式测试咱们的API了.

 

原文连接: http://www.weiguda.com/blog/24/