diff options
Diffstat (limited to 'tutorial')
| -rw-r--r-- | tutorial/1-serialization.html | 4 | ||||
| -rw-r--r-- | tutorial/4-authentication-and-permissions.html | 4 | ||||
| -rw-r--r-- | tutorial/6-viewsets-and-routers.html | 6 |
3 files changed, 7 insertions, 7 deletions
diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html index f8bca54f..9eab9dae 100644 --- a/tutorial/1-serialization.html +++ b/tutorial/1-serialization.html @@ -275,7 +275,7 @@ class Snippet(models.Model): <pre class="prettyprint lang-py"><code>python manage.py syncdb </code></pre> <h2 id="creating-a-serializer-class">Creating a Serializer class</h2> -<p>The first thing we need to get started on our Web API is provide a way of serializing and deserializing the snippet instances into representations such as <code>json</code>. We can do this by declaring serializers that work very similar to Django's forms. Create a file in the <code>snippets</code> directory named <code>serializers.py</code> and add the following.</p> +<p>The first thing we need to get started on our Web API is to provide a way of serializing and deserializing the snippet instances into representations such as <code>json</code>. We can do this by declaring serializers that work very similar to Django's forms. Create a file in the <code>snippets</code> directory named <code>serializers.py</code> and add the following.</p> <pre class="prettyprint lang-py"><code>from django.forms import widgets from rest_framework import serializers from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES @@ -313,7 +313,7 @@ class SnippetSerializer(serializers.Serializer): # Create new instance return Snippet(**attrs) </code></pre> -<p>The first part of serializer class defines the fields that get serialized/deserialized. The <code>restore_object</code> method defines how fully fledged instances get created when deserializing data.</p> +<p>The first part of the serializer class defines the fields that get serialized/deserialized. The <code>restore_object</code> method defines how fully fledged instances get created when deserializing data.</p> <p>Notice that we can also use various attributes that would typically be used on form fields, such as <code>widget=widgets.Textarea</code>. These can be used to control how the serializer should render when displayed as an HTML form. This is particularly useful for controlling how the browsable API should be displayed, as we'll see later in the tutorial.</p> <p>We can actually also save ourselves some time by using the <code>ModelSerializer</code> class, as we'll see later, but for now we'll keep our serializer definition explicit. </p> <h2 id="working-with-serializers">Working with Serializers</h2> diff --git a/tutorial/4-authentication-and-permissions.html b/tutorial/4-authentication-and-permissions.html index d2f2f803..923a2c67 100644 --- a/tutorial/4-authentication-and-permissions.html +++ b/tutorial/4-authentication-and-permissions.html @@ -228,10 +228,10 @@ from pygments import highlight <p>When that's all done we'll need to update our database tables. Normally we'd create a database migration in order to do that, but for the purposes of this tutorial, let's just delete the database and start again.</p> <pre class="prettyprint lang-py"><code>rm tmp.db -python ./manage.py syncdb +python manage.py syncdb </code></pre> <p>You might also want to create a few different users, to use for testing the API. The quickest way to do this will be with the <code>createsuperuser</code> command.</p> -<pre class="prettyprint lang-py"><code>python ./manage.py createsuperuser +<pre class="prettyprint lang-py"><code>python manage.py createsuperuser </code></pre> <h2 id="adding-endpoints-for-our-user-models">Adding endpoints for our User models</h2> <p>Now that we've got some users to work with, we'd better add representations of those users to our API. Creating a new serializer is easy. In <code>serializers.py</code> add:</p> diff --git a/tutorial/6-viewsets-and-routers.html b/tutorial/6-viewsets-and-routers.html index 72bfaf49..5422f7ea 100644 --- a/tutorial/6-viewsets-and-routers.html +++ b/tutorial/6-viewsets-and-routers.html @@ -203,7 +203,7 @@ class UserViewSet(viewsets.ReadOnlyModelViewSet): queryset = User.objects.all() serializer_class = UserSerializer </code></pre> -<p>Here we've used <code>ReadOnlyModelViewSet</code> class to automatically provide the default 'read-only' operations. We're still setting the <code>queryset</code> and <code>serializer_class</code> attributes exactly as we did when we were using regular views, but we no longer need to provide the same information to two separate classes.</p> +<p>Here we've used the <code>ReadOnlyModelViewSet</code> class to automatically provide the default 'read-only' operations. We're still setting the <code>queryset</code> and <code>serializer_class</code> attributes exactly as we did when we were using regular views, but we no longer need to provide the same information to two separate classes.</p> <p>Next we're going to replace the <code>SnippetList</code>, <code>SnippetDetail</code> and <code>SnippetHighlight</code> view classes. We can remove the three views, and again replace them with a single class.</p> <pre class="prettyprint lang-py"><code>from rest_framework.decorators import link @@ -258,7 +258,7 @@ user_detail = UserViewSet.as_view({ }) </code></pre> <p>Notice how we're creating multiple views from each <code>ViewSet</code> class, by binding the http methods to the required action for each view.</p> -<p>Now that we've bound our resources into concrete views, that we can register the views with the URL conf as usual.</p> +<p>Now that we've bound our resources into concrete views, we can register the views with the URL conf as usual.</p> <pre class="prettyprint lang-py"><code>urlpatterns = format_suffix_patterns(patterns('snippets.views', url(r'^$', 'api_root'), url(r'^snippets/$', snippet_list, name='snippet-list'), @@ -297,7 +297,7 @@ urlpatterns = patterns('', <p>We've walked through each step of the design process, and seen how if we need to customize anything we can gradually work our way down to simply using regular Django views.</p> <p>You can review the final <a href="https://github.com/tomchristie/rest-framework-tutorial">tutorial code</a> on GitHub, or try out a live example in <a href="http://restframework.herokuapp.com/">the sandbox</a>.</p> <h2 id="onwards-and-upwards">Onwards and upwards</h2> -<p>We've reached the end of our tutorial. If you want to get more involved in the REST framework project, here's a few places you can start:</p> +<p>We've reached the end of our tutorial. If you want to get more involved in the REST framework project, here are a few places you can start:</p> <ul> <li>Contribute on <a href="https://github.com/tomchristie/django-rest-framework">GitHub</a> by reviewing and submitting issues, and making pull requests.</li> <li>Join the <a href="https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework">REST framework discussion group</a>, and help build the community.</li> |