LOADING

Follow me

Django REST frame(官方教程之三)
十一月 28, 2013|IT

Django REST frame(官方教程之三)



跟着Django的教程走例子,遇到了Django REST Framework的内容,可惜教程用的版本有点老,在Django1.5,Python3.3下例子都通不过。在http://django-rest-framework.org的官网上有教程,我看了看,似乎只有前两部分的中文翻译,就趁着自己看也翻一下后面的部分,自己学习,供大家参考:如有错讹,请多指教。


原始来源:http://django-rest-framework.org/tutorial/3-class-based-views.html


教程3: 基于类的View


在之前基于函数的View之外,我们还可以用基于类的view来实现我们的API view。正如我们即将看到的那样,这样的方式可以让我们重用公用功能,并使我们保持代码DRY。


用基于类的view重写我们的API


我们要用基于类的view来重写刚才的根view,如下重构所示:

复制代码

 1 from snippets.models import Snippet
 2 from snippets.serializers import SnippetSerializer
 3 from django.http import Http404
 4 from rest_framework.views import APIView
 5 from rest_framework.response import Response
 6 from rest_framework import status
 7 
 8 class SnippetList(APIView):
 9     """
10     List all snippets, or create a new snippet.
11     """
12     def get(self, request, format=None):
13         snippets = Snippet.objects.all()
14         serializer = SnippetSerializer(snippets, many=True)
15         return Response(serializer.data)
16 
17     def post(self, request, format=None):
18         serializer = SnippetSerializer(data=request.DATA)
19         if serializer.is_valid():
20             serializer.save()
21             return Response(serializer.data, status=status.HTTP_201_CREATED)
22         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

复制代码


目前看上去不错。它看起来和我们之前写的很相似,但我们在不同的HTTP方法见有了更好的分隔方式,我们还需要把示例的view也重构一下:

复制代码

 1 class SnippetDetail(APIView):
 2     """
 3     Retrieve, update or delete a snippet instance.
 4     """
 5     def get_object(self, pk):
 6         try:
 7             return Snippet.objects.get(pk=pk)
 8         except Snippet.DoesNotExist:
 9             raise Http404
10 
11     def get(self, request, pk, format=None):
12         snippet = self.get_object(pk)
13         serializer = SnippetSerializer(snippet)
14         return Response(serializer.data)
15 
16     def put(self, request, pk, format=None):
17         snippet = self.get_object(pk)
18         serializer = SnippetSerializer(snippet, data=request.DATA)
19         if serializer.is_valid():
20             serializer.save()
21             return Response(serializer.data)
22         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
23 
24     def delete(self, request, pk, format=None):
25         snippet = self.get_object(pk)
26         snippet.delete()
27         return Response(status=status.HTTP_204_NO_CONTENT)

复制代码


做的不错。它和我们之前写的基于函数的view还是有些相像。


我们还需要对URLconf做一些小小的改动:

复制代码

 1 from django.conf.urls import patterns, url
 2 from rest_framework.urlpatterns import format_suffix_patterns
 3 from snippets import views
 4 
 5 urlpatterns = patterns('',
 6     url(r'^snippets/$', views.SnippetList.as_view()),
 7     url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view()),
 8 )
 9 
10 urlpatterns = format_suffix_patterns(urlpatterns)

复制代码


到目前为止,已经全部完成。你可以运行开发服务器,一切应该表现如初。


使用mixins


使用基于类的view的最大好处就是可以让我们方便的组合与重用。


刚才我们的create/retrieve/update/delete等函数实现在模型支撑API view下会很类似。其中的公共行为在REST framework’s mixin类中实现了。


我们来看看,我们可以用mixin类来吧我们的view组合起来:

复制代码

 1 from snippets.models import Snippet
 2 from snippets.serializers import SnippetSerializer
 3 from rest_framework import mixins
 4 from rest_framework import generics
 5 
 6 class SnippetList(mixins.ListModelMixin,
 7                   mixins.CreateModelMixin,
 8                   generics.MultipleObjectAPIView):
 9     model = Snippet
10     serializer_class = SnippetSerializer
11 
12     def get(self, request, *args, **kwargs):
13         return self.list(request, *args, **kwargs)
14 
15     def post(self, request, *args, **kwargs):
16         return self.create(request, *args, **kwargs)

复制代码


我们将花点时间来解释下这里到底发生了什么。我们用MultipleObjectAPIView构建了我们的view, 然后加上了inListModelMixin和CreateModelMixin.


基类提供了核心功能,mixin类提供了 .list() 和 .create() 动作。我们然后显式的把 get 和 post 方法与合适的动作绑定在一起,非常简单。

复制代码

 1 class SnippetDetail(mixins.RetrieveModelMixin,
 2                     mixins.UpdateModelMixin,
 3                     mixins.DestroyModelMixin,
 4                     generics.SingleObjectAPIView):
 5     model = Snippet
 6     serializer_class = SnippetSerializer
 7 
 8     def get(self, request, *args, **kwargs):
 9         return self.retrieve(request, *args, **kwargs)
10 
11     def put(self, request, *args, **kwargs):
12         return self.update(request, *args, **kwargs)
13 
14     def delete(self, request, *args, **kwargs):
15         return self.destroy(request, *args, **kwargs)

复制代码


示例部分的实现也非常类似。这次我们用SingleObjectAPIView来提供核心功能,然后用mixins来提供.retrieve().update() 和 .destroy() actions.


使用基于泛型类的view


使用mixin类可以让我们重写view时写更少的代码,但我们还可以更进一步,REST framework提供了一系列已经mixed-in的泛型view供我们使用。

复制代码

 1 from snippets.models import Snippet
 2 from snippets.serializers import SnippetSerializer
 3 from rest_framework import generics
 4 
 5 class SnippetList(generics.ListCreateAPIView):
 6     model = Snippet
 7     serializer_class = SnippetSerializer
 8 
 9 class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
10     model = Snippet
11     serializer_class = SnippetSerializer

复制代码


Wow, 非常简洁. 我们轻松了不少,而且代码看起来优美,干净和符合Django的习惯。


在第四部分 part 4 of the tutorial, 我们将看看我们的API如何处理认证和权限。


no comments
Share

发表评论