diff options
| author | Tom Christie | 2012-10-28 19:25:51 +0000 | 
|---|---|---|
| committer | Tom Christie | 2012-10-28 19:25:51 +0000 | 
| commit | fde79376f323708d9f7b80ee830fe63060fb335f (patch) | |
| tree | f8b2cf9b1bc9665fb2ebe2ffe3a61ba2ef0aca27 /docs/tutorial/3-class-based-views.md | |
| parent | 12c363c1fe237d0357e6020b44890926856b9191 (diff) | |
| download | django-rest-framework-fde79376f323708d9f7b80ee830fe63060fb335f.tar.bz2 | |
Pastebin tutorial
Diffstat (limited to 'docs/tutorial/3-class-based-views.md')
| -rw-r--r-- | docs/tutorial/3-class-based-views.md | 88 | 
1 files changed, 43 insertions, 45 deletions
| diff --git a/docs/tutorial/3-class-based-views.md b/docs/tutorial/3-class-based-views.md index 0ee81ea3..3d58fe8e 100644 --- a/docs/tutorial/3-class-based-views.md +++ b/docs/tutorial/3-class-based-views.md @@ -6,61 +6,59 @@ We can also write our API views using class based views, rather than function ba  We'll start by rewriting the root view as a class based view.  All this involves is a little bit of refactoring. -    from blog.models import Comment -    from blog.serializers import CommentSerializer +    from snippet.models import Snippet +    from snippet.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 CommentRoot(APIView): +    class SnippetList(APIView):          """ -        List all comments, or create a new comment. +        List all snippets, or create a new snippet.          """          def get(self, request, format=None): -            comments = Comment.objects.all() -            serializer = CommentSerializer(instance=comments) +            snippets = Snippet.objects.all() +            serializer = SnippetSerializer(instance=snippets)              return Response(serializer.data)          def post(self, request, format=None): -            serializer = CommentSerializer(request.DATA) +            serializer = SnippetSerializer(request.DATA)              if serializer.is_valid(): -                comment = serializer.object -                comment.save() +                serializer.save()                  return Response(serializer.data, status=status.HTTP_201_CREATED)              return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)  So far, so good.  It looks pretty similar to the previous case, but we've got better separation between the different HTTP methods.  We'll also need to update the instance view.  -    class CommentInstance(APIView): +    class SnippetDetail(APIView):          """ -        Retrieve, update or delete a comment instance. +        Retrieve, update or delete a snippet instance.          """          def get_object(self, pk):              try: -                return Comment.objects.get(pk=pk) -            except Comment.DoesNotExist: +                return Snippet.objects.get(pk=pk) +            except Snippet.DoesNotExist:                  raise Http404          def get(self, request, pk, format=None): -            comment = self.get_object(pk) -            serializer = CommentSerializer(instance=comment) +            snippet = self.get_object(pk) +            serializer = SnippetSerializer(instance=snippet)              return Response(serializer.data)          def put(self, request, pk, format=None): -            comment = self.get_object(pk) -            serializer = CommentSerializer(request.DATA, instance=comment) +            snippet = self.get_object(pk) +            serializer = SnippetSerializer(request.DATA, instance=snippet)              if serializer.is_valid(): -                comment = serializer.object -                comment.save() +                serializer.save()                  return Response(serializer.data)              return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)          def delete(self, request, pk, format=None): -            comment = self.get_object(pk) -            comment.delete() +            snippet = self.get_object(pk) +            snippet.delete()              return Response(status=status.HTTP_204_NO_CONTENT)  That's looking good.  Again, it's still pretty similar to the function based view right now. @@ -69,11 +67,11 @@ We'll also need to refactor our URLconf slightly now we're using class based vie      from django.conf.urls import patterns, url      from rest_framework.urlpatterns import format_suffix_patterns -    from blogpost import views +    from snippetpost import views      urlpatterns = patterns('', -        url(r'^$', views.CommentRoot.as_view()), -        url(r'^(?P<pk>[0-9]+)$', views.CommentInstance.as_view()) +        url(r'^$', views.SnippetList.as_view()), +        url(r'^(?P<pk>[0-9]+)$', views.SnippetDetail.as_view())      )      urlpatterns = format_suffix_patterns(urlpatterns) @@ -88,16 +86,16 @@ The create/retrieve/update/delete operations that we've been using so far are go  Let's take a look at how we can compose our views by using the mixin classes. -    from blog.models import Comment -    from blog.serializers import CommentSerializer +    from snippet.models import Snippet +    from snippet.serializers import SnippetSerializer      from rest_framework import mixins      from rest_framework import generics -    class CommentRoot(mixins.ListModelMixin, +    class SnippetList(mixins.ListModelMixin,                        mixins.CreateModelMixin,                        generics.MultipleObjectBaseView): -        model = Comment -        serializer_class = CommentSerializer +        model = Snippet +        serializer_class = SnippetSerializer          def get(self, request, *args, **kwargs):              return self.list(request, *args, **kwargs) @@ -109,12 +107,12 @@ We'll take a moment to examine exactly what's happening here - We're building ou  The base class provides the core functionality, and the mixin classes provide the `.list()` and `.create()` actions.  We're then explicitly binding the `get` and `post` methods to the appropriate actions.  Simple enough stuff so far. -    class CommentInstance(mixins.RetrieveModelMixin, -                          mixins.UpdateModelMixin, -                          mixins.DestroyModelMixin, -                          generics.SingleObjectBaseView): -        model = Comment -        serializer_class = CommentSerializer +    class SnippetDetail(mixins.RetrieveModelMixin, +                        mixins.UpdateModelMixin, +                        mixins.DestroyModelMixin, +                        generics.SingleObjectBaseView): +        model = Snippet +        serializer_class = SnippetSerializer          def get(self, request, *args, **kwargs):              return self.retrieve(request, *args, **kwargs) @@ -131,23 +129,23 @@ Pretty similar.  This time we're using the `SingleObjectBaseView` class to provi  Using the mixin classes we've rewritten the views to use slightly less code than before, but we can go one step further.  REST framework provides a set of already mixed-in generic views that we can use. -    from blog.models import Comment -    from blog.serializers import CommentSerializer +    from snippet.models import Snippet +    from snippet.serializers import SnippetSerializer      from rest_framework import generics -    class CommentRoot(generics.ListCreateAPIView): -        model = Comment -        serializer_class = CommentSerializer +    class SnippetList(generics.ListCreateAPIView): +        model = Snippet +        serializer_class = SnippetSerializer -    class CommentInstance(generics.RetrieveUpdateDestroyAPIView): -        model = Comment -        serializer_class = CommentSerializer +    class SnippetDetail(generics.RetrieveUpdateDestroyAPIView): +        model = Snippet +        serializer_class = SnippetSerializer  Wow, that's pretty concise.  We've got a huge amount for free, and our code looks like good, clean, idiomatic Django. -Next we'll move onto [part 4 of the tutorial][tut-4], where we'll take a look at how we can  customize the behavior of our views to support a range of authentication, permissions, throttling and other aspects. +Next we'll move onto [part 4 of the tutorial][tut-4], where we'll take a look at how we can deal with authentication and permissions for our API.  [dry]: http://en.wikipedia.org/wiki/Don't_repeat_yourself -[tut-4]: 4-authentication-permissions-and-throttling.md +[tut-4]: 4-authentication-and-permissions.md | 
