Django REST Framework Tutorial 3:基于类的Views(中文版教程)by hillfree
2013-03-25 19:02
726 查看
跟着Django的教程走例子,遇到了Django REST Framework的内容,可惜教程用的版本有点老,在Django1.5,Python3.3下例子都通不过。在http://django-rest-framework.org的官网上有教程,我看了看,似乎只有前两部分的中文翻译,就趁着自己看也翻一下后面的部分,自己学习,供大家参考:如有错讹,请多指教。
原始来源:http://django-rest-framework.org/tutorial/3-class-based-views.html
目前看上去不错。它看起来和我们之前写的很相似,但我们在不同的HTTP方法见有了更好的分隔方式,我们还需要把示例的view也重构一下:
做的不错。它和我们之前写的基于函数的view还是有些相像。
我们还需要对URLconf做一些小小的改动:
到目前为止,已经全部完成。你可以运行开发服务器,一切应该表现如初。
刚才我们的create/retrieve/update/delete等函数实现在模型支撑API view下会很类似。其中的公共行为在REST framework's mixin类中实现了。
我们来看看,我们可以用mixin类来吧我们的view组合起来:
我们将花点时间来解释下这里到底发生了什么。我们用
基类提供了核心功能,mixin类提供了
示例部分的实现也非常类似。这次我们用
Wow, 非常简洁. 我们轻松了不少,而且代码看起来优美,干净和符合Django的习惯。
在第四部分 part 4 of the tutorial, 我们将看看我们的API如何处理认证和权限。
【translated by Hillfree @2013年3月25日19:01:08】
---------------------------------
zhaoyingm翻译的教程的前两部分:
1. http://blog.csdn.net/zhaoyingm/article/details/8532808
2. http://blog.csdn.net/zhaoyingm/article/details/8531617
原始来源:http://django-rest-framework.org/tutorial/3-class-based-views.html
教程3: 基于类的View
在之前基于函数的View之外,我们还可以用基于类的view来实现我们的API view。正如我们即将看到的那样,这样的方式可以让我们重用公用功能,并使我们保持代码DRY。用基于类的view重写我们的API
我们要用基于类的view来重写刚才的根view,如下重构所示:from snippets.models import Snippet from snippets.serializers import SnippetSerializer from django.http import Http404 from rest_framework.views import APIView from rest_framework.response import Response from rest_framework import status class SnippetList(APIView): """ List all snippets, or create a new snippet. """ def get(self, request, format=None): snippets = Snippet.objects.all() serializer = SnippetSerializer(snippets, many=True) return Response(serializer.data) def post(self, request, format=None): serializer = SnippetSerializer(data=request.DATA) if serializer.is_valid(): serializer.save() return Response(serializer.data, status=status.HTTP_201_CREATED) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
目前看上去不错。它看起来和我们之前写的很相似,但我们在不同的HTTP方法见有了更好的分隔方式,我们还需要把示例的view也重构一下:
class SnippetDetail(APIView): """ Retrieve, update or delete a snippet instance. """ def get_object(self, pk): try: return Snippet.objects.get(pk=pk) except Snippet.DoesNotExist: raise Http404 def get(self, request, pk, format=None): snippet = self.get_object(pk) serializer = SnippetSerializer(snippet) return Response(serializer.data) def put(self, request, pk, format=None): snippet = self.get_object(pk) serializer = SnippetSerializer(snippet, data=request.DATA) if serializer.is_valid(): serializer.save() return Response(serializer.data) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) def delete(self, request, pk, format=None): snippet = self.get_object(pk) snippet.delete() return Response(status=status.HTTP_204_NO_CONTENT)
做的不错。它和我们之前写的基于函数的view还是有些相像。
我们还需要对URLconf做一些小小的改动:
from django.conf.urls import patterns, url from rest_framework.urlpatterns import format_suffix_patterns from snippets import views urlpatterns = patterns('', url(r'^snippets/$', views.SnippetList.as_view()), url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view()), ) urlpatterns = format_suffix_patterns(urlpatterns)
到目前为止,已经全部完成。你可以运行开发服务器,一切应该表现如初。
使用mixins
使用基于类的view的最大好处就是可以让我们方便的组合与重用。刚才我们的create/retrieve/update/delete等函数实现在模型支撑API view下会很类似。其中的公共行为在REST framework's mixin类中实现了。
我们来看看,我们可以用mixin类来吧我们的view组合起来:
from snippets.models import Snippet from snippets.serializers import SnippetSerializer from rest_framework import mixins from rest_framework import generics class SnippetList(mixins.ListModelMixin, mixins.CreateModelMixin, generics.MultipleObjectAPIView): model = Snippet serializer_class = SnippetSerializer def get(self, request, *args, **kwargs): return self.list(request, *args, **kwargs) def post(self, request, *args, **kwargs): return self.create(request, *args, **kwargs)
我们将花点时间来解释下这里到底发生了什么。我们用
MultipleObjectAPIView构建了我们的view, 然后加上了in
ListModelMixin和
CreateModelMixin.
基类提供了核心功能,mixin类提供了
.list()和
.create()动作。我们然后显式的把
get和
post方法与合适的动作绑定在一起,非常简单。
class SnippetDetail(mixins.RetrieveModelMixin, mixins.UpdateModelMixin, mixins.DestroyModelMixin, generics.SingleObjectAPIView): model = Snippet serializer_class = SnippetSerializer def get(self, request, *args, **kwargs): return self.retrieve(request, *args, **kwargs) def put(self, request, *args, **kwargs): return self.update(request, *args, **kwargs) def delete(self, request, *args, **kwargs): return self.destroy(request, *args, **kwargs)
示例部分的实现也非常类似。这次我们用
SingleObjectAPIView来提供核心功能,然后用mixins来提供
.retrieve(),
.update()和
.destroy()actions.
使用基于泛型类的view
使用mixin类可以让我们重写view时写更少的代码,但我们还可以更进一步,REST framework提供了一系列已经mixed-in的泛型view供我们使用。from snippets.models import Snippet from snippets.serializers import SnippetSerializer from rest_framework import generics class SnippetList(generics.ListCreateAPIView): model = Snippet serializer_class = SnippetSerializer class SnippetDetail(generics.RetrieveUpdateDestroyAPIView): model = Snippet serializer_class = SnippetSerializer
Wow, 非常简洁. 我们轻松了不少,而且代码看起来优美,干净和符合Django的习惯。
在第四部分 part 4 of the tutorial, 我们将看看我们的API如何处理认证和权限。
【translated by Hillfree @2013年3月25日19:01:08】
---------------------------------
zhaoyingm翻译的教程的前两部分:
1. http://blog.csdn.net/zhaoyingm/article/details/8532808
2. http://blog.csdn.net/zhaoyingm/article/details/8531617
相关文章推荐
- Django REST Framework Tutorial 5:关系与超链接API(中文版教程)by hillfree
- Django REST Framework Tutorial 4:认证与权限(中文版教程)by hillfree
- Django-REST-framework教程中文版
- Django-Rest-Framework 教程: 3. 使用 class based views
- Django-Rest-Framework 教程: 快速入门
- Django REST FrameWork中文教程2:请求和响应
- Django REST FrameWork中文教程6: ViewSets&Routers
- 【备忘】[全栈开发 ]Vue+Django REST framework 打造生鲜电商项目视频教程
- django-rest-framework之基于类的视图
- Django REST framework(官方教程-六)
- Python3+PyCharm+Django+Django REST framework开发教程
- Django1.5内置的用户认证系统介绍(之二)使用User对象--by hillfree
- Django-Rest-Framework 教程: 快速入门
- Django1.5内置的用户认证系统介绍(之一)--by hillfree
- Django1.5内置的用户认证系统介绍(之三)权限与授权--by hillfree
- Django-Rest-Framework 教程: 1. 序列化 (Serialization)
- django rest_framework--入门教程2
- Django-Rest-Framework 教程
- django rest_framework--入门教程
- Django1.5内置的用户认证系统介绍(之四)Authentication in Web requests --by hillfree