mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-12-04 23:44:07 +03:00
Latest docs build
This commit is contained in:
parent
e5c8c6ea50
commit
f7c3387574
|
@ -176,6 +176,7 @@ class Comment(models.Model):
|
||||||
from rest_framework import serializers
|
from rest_framework import serializers
|
||||||
|
|
||||||
class CommentSerializer(serializers.Serializer):
|
class CommentSerializer(serializers.Serializer):
|
||||||
|
id = serializers.IntegerField(readonly=True)
|
||||||
email = serializers.EmailField()
|
email = serializers.EmailField()
|
||||||
content = serializers.CharField(max_length=200)
|
content = serializers.CharField(max_length=200)
|
||||||
created = serializers.DateTimeField()
|
created = serializers.DateTimeField()
|
||||||
|
@ -214,12 +215,12 @@ c3.save()
|
||||||
<p>We've now got a few comment instances to play with. Let's take a look at serializing one of those instances.</p>
|
<p>We've now got a few comment instances to play with. Let's take a look at serializing one of those instances.</p>
|
||||||
<pre class="prettyprint lang-py"><code>serializer = CommentSerializer(instance=c1)
|
<pre class="prettyprint lang-py"><code>serializer = CommentSerializer(instance=c1)
|
||||||
serializer.data
|
serializer.data
|
||||||
# {'email': u'leila@example.com', 'content': u'nothing to say', 'created': datetime.datetime(2012, 8, 22, 16, 20, 9, 822774, tzinfo=<UTC>)}
|
# {'id': 1, 'email': u'leila@example.com', 'content': u'nothing to say', 'created': datetime.datetime(2012, 8, 22, 16, 20, 9, 822774, tzinfo=<UTC>)}
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>At this point we've translated the model instance into python native datatypes. To finalise the serialization process we render the data into <code>json</code>.</p>
|
<p>At this point we've translated the model instance into python native datatypes. To finalise the serialization process we render the data into <code>json</code>.</p>
|
||||||
<pre class="prettyprint lang-py"><code>stream = JSONRenderer().render(serializer.data)
|
<pre class="prettyprint lang-py"><code>stream = JSONRenderer().render(serializer.data)
|
||||||
stream
|
stream
|
||||||
# '{"email": "leila@example.com", "content": "nothing to say", "created": "2012-08-22T16:20:09.822"}'
|
# '{"id": 1, "email": "leila@example.com", "content": "nothing to say", "created": "2012-08-22T16:20:09.822"}'
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Deserialization is similar. First we parse a stream into python native datatypes... </p>
|
<p>Deserialization is similar. First we parse a stream into python native datatypes... </p>
|
||||||
<pre class="prettyprint lang-py"><code>data = JSONParser().parse(stream)
|
<pre class="prettyprint lang-py"><code>data = JSONParser().parse(stream)
|
||||||
|
@ -238,9 +239,10 @@ We'll start off by creating a subclass of HttpResponse that we can use to render
|
||||||
<p>Edit the <code>blog/views.py</code> file, and add the following.</p>
|
<p>Edit the <code>blog/views.py</code> file, and add the following.</p>
|
||||||
<pre class="prettyprint lang-py"><code>from blog.models import Comment
|
<pre class="prettyprint lang-py"><code>from blog.models import Comment
|
||||||
from blog.serializers import CommentSerializer
|
from blog.serializers import CommentSerializer
|
||||||
|
from django.http import HttpResponse
|
||||||
|
from django.views.decorators.csrf import csrf_exempt
|
||||||
from rest_framework.renderers import JSONRenderer
|
from rest_framework.renderers import JSONRenderer
|
||||||
from rest_framework.parsers import JSONParser
|
from rest_framework.parsers import JSONParser
|
||||||
from django.http import HttpResponse
|
|
||||||
|
|
||||||
class JSONResponse(HttpResponse):
|
class JSONResponse(HttpResponse):
|
||||||
"""
|
"""
|
||||||
|
@ -253,7 +255,8 @@ class JSONResponse(HttpResponse):
|
||||||
super(JSONResponse, self).__init__(content, **kwargs)
|
super(JSONResponse, self).__init__(content, **kwargs)
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>The root of our API is going to be a view that supports listing all the existing comments, or creating a new comment.</p>
|
<p>The root of our API is going to be a view that supports listing all the existing comments, or creating a new comment.</p>
|
||||||
<pre class="prettyprint lang-py"><code>def comment_root(request):
|
<pre class="prettyprint lang-py"><code>@csrf_exempt
|
||||||
|
def comment_root(request):
|
||||||
"""
|
"""
|
||||||
List all comments, or create a new comment.
|
List all comments, or create a new comment.
|
||||||
"""
|
"""
|
||||||
|
@ -272,8 +275,10 @@ class JSONResponse(HttpResponse):
|
||||||
else:
|
else:
|
||||||
return JSONResponse(serializer.errors, status=400)
|
return JSONResponse(serializer.errors, status=400)
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
<p>Note that because we want to be able to POST to this view from clients that won't have a CSRF token we need to mark the view as <code>csrf_exempt</code>. This isn't something that you'd normally want to do, and REST framework views actually use more sensible behavior than this, but it'll do for our purposes right now. </p>
|
||||||
<p>We'll also need a view which corrosponds to an individual comment, and can be used to retrieve, update or delete the comment.</p>
|
<p>We'll also need a view which corrosponds to an individual comment, and can be used to retrieve, update or delete the comment.</p>
|
||||||
<pre class="prettyprint lang-py"><code>def comment_instance(request, pk):
|
<pre class="prettyprint lang-py"><code>@csrf_exempt
|
||||||
|
def comment_instance(request, pk):
|
||||||
"""
|
"""
|
||||||
Retrieve, update or delete a comment instance.
|
Retrieve, update or delete a comment instance.
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -152,7 +152,7 @@ class CommentRoot(APIView):
|
||||||
comment = self.get_object(pk)
|
comment = self.get_object(pk)
|
||||||
serializer = CommentSerializer(request.DATA, instance=comment)
|
serializer = CommentSerializer(request.DATA, instance=comment)
|
||||||
if serializer.is_valid():
|
if serializer.is_valid():
|
||||||
comment = serializer.deserialized
|
comment = serializer.object
|
||||||
comment.save()
|
comment.save()
|
||||||
return Response(serializer.data)
|
return Response(serializer.data)
|
||||||
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
|
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user