diff options
| author | Alec Perkins | 2012-09-09 13:23:07 -0400 |
|---|---|---|
| committer | Alec Perkins | 2012-09-09 13:23:07 -0400 |
| commit | 45001033378a49986d4cd7f5bdf4673b083cdbd0 (patch) | |
| tree | e5eb2cd49d122ba56d63058413cb3d4d138dae7a /docs/tutorial | |
| parent | 0ae5500f34a81005ba0161dacb280a94f768a885 (diff) | |
| parent | d4f8b4cf0683923fe85652f8fd572d2931eb3074 (diff) | |
| download | django-rest-framework-45001033378a49986d4cd7f5bdf4673b083cdbd0.tar.bz2 | |
Merge 'tomchristie/restframework2' into 'browsable-bootstrap'
Diffstat (limited to 'docs/tutorial')
| -rw-r--r-- | docs/tutorial/1-serialization.md | 1 | ||||
| -rw-r--r-- | docs/tutorial/3-class-based-views.md | 27 | ||||
| -rw-r--r-- | docs/tutorial/6-resource-orientated-projects.md | 2 |
3 files changed, 16 insertions, 14 deletions
diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md index 3d6615d9..610d8ed1 100644 --- a/docs/tutorial/1-serialization.md +++ b/docs/tutorial/1-serialization.md @@ -8,6 +8,7 @@ This tutorial will walk you through the building blocks that make up REST framew Before we do anything else we'll create a new virtual environment, using [virtualenv]. This will make sure our package configuration is keep nicely isolated from any other projects we're working on. + :::bash mkdir ~/env virtualenv --no-site-packages ~/env/tutorial source ~/env/tutorial/bin/activate diff --git a/docs/tutorial/3-class-based-views.md b/docs/tutorial/3-class-based-views.md index b3000ad9..24785179 100644 --- a/docs/tutorial/3-class-based-views.md +++ b/docs/tutorial/3-class-based-views.md @@ -7,30 +7,31 @@ 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 ComentSerializer + from blog.serializers import CommentSerializer from django.http import Http404 from djangorestframework.views import APIView from djangorestframework.response import Response - from djangorestframework.status import status + from djangorestframework import status + class CommentRoot(APIView): """ List all comments, or create a new comment. - """ + """ def get(self, request, format=None): comments = Comment.objects.all() - serializer = ComentSerializer(instance=comments) + serializer = CommentSerializer(instance=comments) return Response(serializer.data) - def post(self, request, format=None) - serializer = ComentSerializer(request.DATA) + def post(self, request, format=None): + serializer = CommentSerializer(request.DATA) if serializer.is_valid(): comment = serializer.object comment.save() - return Response(serializer.serialized, status=HTTP_201_CREATED) - return Response(serializer.serialized_errors, status=HTTP_400_BAD_REQUEST) + return Response(serializer.serialized, status=status.HTTP_201_CREATED) + return Response(serializer.serialized_errors, status=status.HTTP_400_BAD_REQUEST) - comment_root = CommentRoot.as_view() + comment_root = CommentRoot.as_view() So far, so good. It looks pretty similar to the previous case, but we've got better seperation between the different HTTP methods. We'll also need to update the instance view. @@ -38,18 +39,18 @@ So far, so good. It looks pretty similar to the previous case, but we've got be """ Retrieve, update or delete a comment instance. """ - + def get_object(self, pk): try: return Comment.objects.get(pk=pk) except Comment.DoesNotExist: raise Http404 - + def get(self, request, pk, format=None): comment = self.get_object(pk) serializer = CommentSerializer(instance=comment) return Response(serializer.data) - + def put(self, request, pk, format=None): comment = self.get_object(pk) serializer = CommentSerializer(request.DATA, instance=comment) @@ -64,7 +65,7 @@ So far, so good. It looks pretty similar to the previous case, but we've got be comment.delete() return Response(status=status.HTTP_204_NO_CONTENT) - comment_instance = CommentInstance.as_view() + comment_instance = CommentInstance.as_view() That's looking good. Again, it's still pretty similar to the function based view right now. Okay, we're done. If you run the development server everything should be working just as before. diff --git a/docs/tutorial/6-resource-orientated-projects.md b/docs/tutorial/6-resource-orientated-projects.md index ce51cce5..4282c25d 100644 --- a/docs/tutorial/6-resource-orientated-projects.md +++ b/docs/tutorial/6-resource-orientated-projects.md @@ -44,6 +44,6 @@ We've reached the end of our tutorial. If you want to get more involved in the * Contribute on GitHub by reviewing issues, and submitting issues or pull requests. * Join the REST framework group, and help build the community. -* Follow me on Twitter and say hi. +* Follow me [on Twitter](https://twitter.com/_tomchristie) and say hi. Now go build something great.
\ No newline at end of file |
