zoukankan      html  css  js  c++  java
  • Django REST framework 第六章 ViewSets & Routers

    REST framework包含了一个可以处理ViewSets的抽象, 它允许开发人员专注于API的状态跟交互进行建模,并使得URL构建结构基于通用的约定自动处理。

    ViewSet类跟View类几乎相同,除此之外它提供了一些其他的操作,比如readupdate,而不像view的getput

    一个ViewSet类最后只能绑定到一组方法处理程序,当它被实例化成一组视图时,经常使用一个Router类来处理定义的复杂的URL配置

    Refactoring to use ViewSets

    让我们用现在的views来重构成viewsets. 首先,将UserList和UserDetail视图重构成一个单独的UserViewSet. 可以移除掉这两个视图,用下面的代替它们

    from rest_framework import viewsets
    
    class UserViewSet(viewsets.ReadOnlyModelViewSet):
        """
        This viewset automatically provides `list` and `detail` actions.
        """
        queryset = User.objects.all()
        serializer_class = UserSerializer

    这里我们已经使用了ReadOnlyModelViewSet类自动提供默认的只读操作。当我们使用正常视图,仍然要明确设置queryset和serializer_class属性,但我们再也不用向2个不同的类提供相同的信息。

    然后我们将要替换SnippetList, SnippetDetail和SnippetHighlight视图类. 同样的可以移除这三个类,使用一个单独的类:

    from rest_framework.decorators import action
    from rest_framework.response import Response
    
    class SnippetViewSet(viewsets.ModelViewSet):
        """
        This viewset automatically provides `list`, `create`, `retrieve`,
        `update` and `destroy` actions.
    
        Additionally we also provide an extra `highlight` action.
        """
        queryset = Snippet.objects.all()
        serializer_class = SnippetSerializer
        permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                              IsOwnerOrReadOnly,)
    
        @action(detail=True, renderer_classes=[renderers.StaticHTMLRenderer])
        def highlight(self, request, *args, **kwargs):
            snippet = self.get_object()
            return Response(snippet.highlighted)
    
        def perform_create(self, serializer):
            serializer.save(owner=self.request.user)

    此时为了获取完整的读写操作集,我们使用了ModelViewSet. 注意我们已经使用了@action装饰器来创建一个定制化的操作,叫做highlight. 这个装饰器能够被使用来添加任何的定制化终端,不在需要匹配标准的create/update/delete风格.

    使用@action装饰器的自定义操作默认响应GET请求. 我们可以使用methods参数,如果我们向一个操作响应POST请求

    默认情况下自定义操作的url依赖于方法名称本身. 如果你想改变URL的构成,你可以引入url_path作为一个装饰器关键字参数

    Binding ViewSets to URLs explictily

    当我们定义URL设置,处理方法只能得到给定的操作。想知道内部具体做了写什么,让我们首先明确地用ViewSets创建一个视图

    在app内的urls文件中绑定ViewSets:

    from app01.views import SnippetViewSet, UserViewSet, api_root
    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'
    })

    注意一下,我们是如何创建每一个ViewSets类的多个视图,为每一个视图绑定http方法跟需要的操作

    urlpatterns = [
        path('snippets/', snippet_list, name='snippet-list'),
        path('snippets/<int:pk>/', snippet_detail, name='snippet-detail'),
        path('users/', user_list, name='user-list'),
        path('users/<int:pk>/', user_detail, name='user-detail'),
        path('snippets/<int:pk>/highlight/', snippet_highlight, name='snippet-highlight'),
        path('', views.api_root),
    ]
    urlpatterns = format_suffix_patterns(urlpatterns)

    Using Router

    因为想比于View类我们使用了ViewSet类,事实上就没必要再自己设计URL设定了。将资源连接到views和urls的约定可以使用Router类. 所有我们要做的只是注册用路由注册一个合适的视图集,让我们做完剩下的。

    修改app内的urls文件

    from django.conf.urls import url, include
    from rest_framework.routers import DefaultRouter
    from app01 import views
    
    # Create a router and register our viewsets with it.
    router = DefaultRouter()
    router.register(r'snippets', views.SnippetViewSet)
    router.register(r'users', views.UserViewSet)
    
    # The API URLs are now determined automatically by the router.
    urlpatterns = [
        url(r'^', include(router.urls))
    ]

    用路由器注册视图集类似于提供URL模式。我们包括两个参数——视图的URL前缀和视图集本身。

    使用的DefaultRouter类也自动为我们创建API根视图,所以我们现在可以从views中删除api_root方法。

  • 相关阅读:
    值得学习:低成本创业的成功案例
    观川剧变脸绝技有感
    庸人、常人、能人和人才,你是哪一种?
    游黄浦江有感
    首出四川有感
    一个容易被人遗忘的管理技巧
    妈妈,对不起
    ora00600[kkocxj:pjpCtx]内部错误一例
    How to troubleshooting RAC Vip Problem
    TSM配置导致RMAN备份expired
  • 原文地址:https://www.cnblogs.com/wuzdandz/p/9463771.html
Copyright © 2011-2022 走看看