From 1fab48703015c4613d62be0712307104bdd94780 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Sat, 8 Sep 2012 20:24:07 +0100 Subject: [PATCH] Code highlighting --- api-guide/authentication.html | 12 +-- api-guide/contentnegotiation.html | 4 +- api-guide/exceptions.html | 4 +- api-guide/parsers.html | 4 +- api-guide/permissions.html | 4 +- api-guide/renderers.html | 4 +- api-guide/requests.html | 4 +- api-guide/responses.html | 4 +- api-guide/reverse.html | 6 +- api-guide/serializers.html | 32 ++++---- api-guide/settings.html | 14 ++-- api-guide/status-codes.html | 16 ++-- api-guide/throttling.html | 4 +- api-guide/views.html | 4 +- css/drf-styles.css | 3 + css/prettify.css | 30 +++++++ index.html | 16 ++-- js/prettify.js | 28 +++++++ topics/contributing.html | 4 +- topics/credits.html | 81 ++++++++++--------- topics/csrf.html | 4 +- topics/formoverloading.html | 8 +- tutorial/1-serialization.html | 45 ++++++----- tutorial/2-requests-and-responses.html | 18 +++-- tutorial/3-class-based-views.html | 14 ++-- ...entication-permissions-and-throttling.html | 4 +- .../5-relationships-and-hyperlinked-apis.html | 4 +- tutorial/6-resource-orientated-projects.html | 10 ++- 28 files changed, 249 insertions(+), 136 deletions(-) create mode 100644 css/prettify.css create mode 100644 js/prettify.js diff --git a/api-guide/authentication.html b/api-guide/authentication.html index 863e4649c..8a7f36f8f 100644 --- a/api-guide/authentication.html +++ b/api-guide/authentication.html @@ -7,6 +7,7 @@ + @@ -15,7 +16,7 @@ - +
@@ -113,7 +114,7 @@

The value of request.user and request.auth for unauthenticated requests can be modified using the UNAUTHENTICATED_USER and UNAUTHENTICATED_TOKEN settings.

Setting the authentication policy

The default authentication policy may be set globally, using the DEFAULT_AUTHENTICATION setting. For example.

-
API_SETTINGS = {
+
API_SETTINGS = {
     'DEFAULT_AUTHENTICATION': (
         'djangorestframework.authentication.UserBasicAuthentication',
         'djangorestframework.authentication.SessionAuthentication',
@@ -121,7 +122,7 @@
 }
 

 
You can also set the authentication policy on a per-view basis, using the APIView class based views.

-
class ExampleView(APIView):
+
class ExampleView(APIView):
     authentication_classes = (SessionAuthentication, UserBasicAuthentication)
 
     def get(self, request, format=None):
@@ -132,7 +133,7 @@
         return Response(content)
 

 
Or, if you're using the @api_view decorator with function based views.

-
@api_view(
+
@api_view(
     allowed=('GET',),
     authentication_classes=(SessionAuthentication, UserBasicAuthentication)
 )
@@ -153,7 +154,7 @@ def example_view(request, format=None):
 
 
TokenAuthentication

 
This policy uses HTTP Authentication with no authentication scheme.  Token basic authentication is appropriate for client-server setups, such as native desktop and mobile clients.  The token key should be passed in as a string to the "Authorization" HTTP header.  For example:

-
curl http://my.api.org/ -X POST -H "Authorization: 0123456789abcdef0123456789abcdef"
+
curl http://my.api.org/ -X POST -H "Authorization: 0123456789abcdef0123456789abcdef"
 

 
Note: If you run TokenAuthentication in production your API must be https only, or it will be completely insecure.

 
If successfully authenticated, TokenAuthentication provides the following credentials.

@@ -186,6 +187,7 @@ def example_view(request, format=None):
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/contentnegotiation.html b/api-guide/contentnegotiation.html
index 0cfb3bc19..4f89538c4 100644
--- a/api-guide/contentnegotiation.html
+++ b/api-guide/contentnegotiation.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -104,6 +105,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/exceptions.html b/api-guide/exceptions.html
index 1b8eb0493..b8d5e1694 100644
--- a/api-guide/exceptions.html
+++ b/api-guide/exceptions.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -103,6 +104,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/parsers.html b/api-guide/parsers.html
index 011ca6189..381e0396d 100644
--- a/api-guide/parsers.html
+++ b/api-guide/parsers.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -105,6 +106,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/permissions.html b/api-guide/permissions.html
index 058b3556a..9c6bc8c65 100644
--- a/api-guide/permissions.html
+++ b/api-guide/permissions.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -102,6 +103,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/renderers.html b/api-guide/renderers.html
index 43e4f1051..e953371e5 100644
--- a/api-guide/renderers.html
+++ b/api-guide/renderers.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -105,6 +106,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/requests.html b/api-guide/requests.html
index 171a87b78..2fba44fe4 100644
--- a/api-guide/requests.html
+++ b/api-guide/requests.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -146,6 +147,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/responses.html b/api-guide/responses.html
index 81ebb2998..75758a91f 100644
--- a/api-guide/responses.html
+++ b/api-guide/responses.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -118,6 +119,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/reverse.html b/api-guide/reverse.html
index 5bfffa8a8..65f435fb6 100644
--- a/api-guide/reverse.html
+++ b/api-guide/reverse.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -113,7 +114,7 @@
 
There's no requirement for you to use them, but if you do then the self-describing API will be able to automatically hyperlink it's output for you, which makes browsing the API much easier.

 
reverse(viewname, request, args, *kwargs)

 
Has the same behavior as django.core.urlresolvers.reverse, except that it returns a fully qualified URL, using the request to determine the host and port.

-
from djangorestframework.utils import reverse
+
from djangorestframework.utils import reverse
 from djangorestframework.views import APIView
 
 class MyView(APIView):
@@ -134,6 +135,7 @@ class MyView(APIView):
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/serializers.html b/api-guide/serializers.html
index 4278b4ea8..8c508bd16 100644
--- a/api-guide/serializers.html
+++ b/api-guide/serializers.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -118,7 +119,7 @@ area would be gratefully accepted.

 
REST framework's serializers work very similarly to Django's Form and ModelForm classes.  It provides a Serializer class which gives you a powerful, generic way to control the output of your responses, as well as a ModelSerializer class which provides a useful shortcut for creating serializers that deal with model instances and querysets.

 
Declaring Serializers

 
Let's start by creating a simple object we can use for example purposes:

-
class Comment(object):
+
class Comment(object):
     def __init__(self, email, content, created=None):
         self.email = email
         self.content = content
@@ -128,7 +129,7 @@ comment = Comment(email='leila@example.com', content='foo bar')
 

 
We'll declare a serializer that we can use to serialize and deserialize Comment objects.
 Declaring a serializer looks very similar to declaring a form:

-
class CommentSerializer(serializers.Serializer):
+
class CommentSerializer(serializers.Serializer):
     email = serializers.EmailField()
     content = serializers.CharField(max_length=200)
     created = serializers.DateTimeField()
@@ -144,21 +145,21 @@ Declaring a serializer looks very similar to declaring a form:

 
The first part of serializer class defines the fields that get serialized/deserialized.  The restore_object method defines how fully fledged instances get created when deserializing data.  The restore_object method is optional, and is only required if we want our serializer to support deserialization.

 
Serializing objects

 
We can now use CommentSerializer to serialize a comment, or list of comments.  Again, using the Serializer class looks a lot like using a Form class.

-
serializer = CommentSerializer(instance=comment)
+
serializer = CommentSerializer(instance=comment)
 serializer.data
 # {'email': u'leila@example.com', 'content': u'foo bar', 'created': datetime.datetime(2012, 8, 22, 16, 20, 9, 822774)}
 

 
At this point we've translated the model instance into python native datatypes.  To finalise the serialization process we render the data into json.

-
stream = JSONRenderer().render(data)
+
stream = JSONRenderer().render(data)
 stream
 # '{"email": "leila@example.com", "content": "foo bar", "created": "2012-08-22T16:20:09.822"}'
 

 
Deserializing objects

 
Deserialization is similar.  First we parse a stream into python native datatypes... 

-
data = JSONParser().parse(stream)
+
data = JSONParser().parse(stream)
 

 
...then we restore those native datatypes into a fully populated object instance.

-
serializer = CommentSerializer(data)
+
serializer = CommentSerializer(data)
 serializer.is_valid()
 # True
 serializer.object
@@ -172,7 +173,7 @@ serializer.object
 
The previous example is fine for dealing with objects that only have simple datatypes, but sometimes we also need to be able to represent more complex objects,
 where some of the attributes of an object might not be simple datatypes such as strings, dates or integers.

 
The Serializer class is itself a type of Field, and can be used to represent relationships where one object type is nested inside another.

-
class UserSerializer(serializers.Serializer):
+
class UserSerializer(serializers.Serializer):
     email = serializers.EmailField()
     username = serializers.CharField()
 
@@ -192,7 +193,7 @@ class CommentSerializer(serializers.Serializer):
 
If you want to create a custom field, you'll probably want to override either one or both of the .to_native() and .from_native() methods.  These two methods are used to convert between the intial datatype, and a primative, serializable datatype.  Primative datatypes may be any of a number, string, date/time/datetime or None.  They may also be any list or dictionary like object that only contains other primative objects.

 
The .to_native() method is called to convert the initial datatype into a primative, serializable datatype.  The from_native() method is called to restore a primative datatype into it's initial representation.

 
Let's look at an example of serializing a class that represents an RGB color value:

-
class Color(object):
+
class Color(object):
     """
     A color represented in the RGB colorspace.
     """
@@ -217,7 +218,7 @@ class ColourField(Field):
 

 
By default field values are treated as mapping to an attribute on the object.  If you need to customize how the field value is accessed and set you need to override .field_to_native() and/or .field_from_native().

 
As an example, let's create a field that can be used represent the class name of the object being serialized:

-
class ClassNameField(Field):
+
class ClassNameField(Field):
     def field_to_native(self, obj, field_name):
         """
         Serialize the object's class name, not an attribute of the object.
@@ -234,14 +235,14 @@ class ColourField(Field):
 
ModelSerializers

 
Often you'll want serializer classes that map closely to model definitions.
 The ModelSerializer class lets you automatically create a Serializer class with fields that corrospond to the Model fields.

-
class AccountSerializer(ModelSerializer):
+
class AccountSerializer(ModelSerializer):
     class Meta:
         model = Account
 

 
[TODO: Explain model field to serializer field mapping in more detail]

 
Specifying fields explicitly

 
You can add extra fields to a ModelSerializer or override the default fields by declaring fields on the class, just as you would for a Serializer class.

-
class AccountSerializer(ModelSerializer):
+
class AccountSerializer(ModelSerializer):
     url = CharField(source='get_absolute_url', readonly=True)
     group = NaturalKeyField()
 
@@ -259,7 +260,7 @@ The ModelSerializer class lets you automatically create a Serialize
 
Specifying which fields should be included

 
If you only want a subset of the default fields to be used in a model serializer, you can do so using fields or exclude options, just as you would with a ModelForm.

 
For example:

-
class AccountSerializer(ModelSerializer):
+
class AccountSerializer(ModelSerializer):
     class Meta:
         model = Account
         exclude = ('id',)
@@ -268,7 +269,7 @@ The ModelSerializer class lets you automatically create a Serialize
 
[TODO: Possibly only allow .serialize(fields=…) in FixtureSerializer for backwards compatability, but remove for ModelSerializer]

 
Specifiying nested serialization

 
The default ModelSerializer uses primary keys for relationships, but you can also easily generate nested representations using the nested option:

-
class AccountSerializer(ModelSerializer):
+
class AccountSerializer(ModelSerializer):
     class Meta:
         model = Account
         exclude = ('id',)
@@ -279,7 +280,7 @@ The ModelSerializer class lets you automatically create a Serialize
 
The nested option may also be set by passing it to the serialize() method.

 
[TODO: Possibly only allow .serialize(nested=…) in FixtureSerializer]

 
Customising the default fields used by a ModelSerializer

-
class AccountSerializer(ModelSerializer):
+
class AccountSerializer(ModelSerializer):
     class Meta:
         model = Account
 
@@ -300,6 +301,7 @@ The ModelSerializer class lets you automatically create a Serialize
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/settings.html b/api-guide/settings.html
index a8bb43b33..4f1fa002d 100644
--- a/api-guide/settings.html
+++ b/api-guide/settings.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -112,7 +113,7 @@
           
Settings

 
Configuration for REST framework is all namespaced inside the API_SETTINGS setting.

 
For example your project's settings.py file might look like this:

-
API_SETTINGS = {
+
API_SETTINGS = {
     'DEFAULT_RENDERERS': (
         'djangorestframework.renderers.YAMLRenderer',
     )
@@ -124,7 +125,7 @@
 
Accessing settings

 
If you need to access the values of REST framework's API settings in your project,
 you should use the api_settings object.  For example.

-
from djangorestframework.settings import api_settings
+
from djangorestframework.settings import api_settings
 
 print api_settings.DEFAULT_AUTHENTICATION
 

@@ -132,7 +133,7 @@ print api_settings.DEFAULT_AUTHENTICATION
 
DEFAULT_RENDERERS

 
A list or tuple of renderer classes, that determines the default set of renderers that may be used when returning a Response object.

 
Default:

-
(
+
(
     'djangorestframework.renderers.JSONRenderer',
     'djangorestframework.renderers.DocumentingHTMLRenderer'
     'djangorestframework.renderers.TemplateHTMLRenderer'
@@ -141,7 +142,7 @@ print api_settings.DEFAULT_AUTHENTICATION
 
DEFAULT_PARSERS

 
A list or tuple of parser classes, that determines the default set of parsers used when accessing the request.DATA property.

 
Default:

-
(
+
(
     'djangorestframework.parsers.JSONParser',
     'djangorestframework.parsers.FormParser'
 )
@@ -149,7 +150,7 @@ print api_settings.DEFAULT_AUTHENTICATION
 
DEFAULT_AUTHENTICATION

 
A list or tuple of authentication classes, that determines the default set of authenticators used when accessing the request.user or request.auth properties.

 
Default:

-
(
+
(
     'djangorestframework.authentication.SessionAuthentication',
     'djangorestframework.authentication.UserBasicAuthentication'
 )
@@ -199,6 +200,7 @@ print api_settings.DEFAULT_AUTHENTICATION
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/status-codes.html b/api-guide/status-codes.html
index 4962b9a5e..96948af61 100644
--- a/api-guide/status-codes.html
+++ b/api-guide/status-codes.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -105,7 +106,7 @@
 
— RFC 2324, Hyper Text Coffee Pot Control Protocol

 
 
Using bare status codes in your responses isn't recommended.  REST framework includes a set of named constants that you can use to make more code more obvious and readable.

-
from djangorestframework import status
+
from djangorestframework import status
 
 def empty_view(self):
     content = {'please move along': 'nothing to see here'}
@@ -116,12 +117,12 @@ def empty_view(self):
 and RFC 6585.

 
Informational - 1xx

 
This class of status code indicates a provisional response.  There are no 1xx status codes used in REST framework by default.

-
HTTP_100_CONTINUE
+
HTTP_100_CONTINUE
 HTTP_101_SWITCHING_PROTOCOLS
 

 
Successful - 2xx

 
This class of status code indicates that the client's request was successfully received, understood, and accepted.

-
HTTP_200_OK
+
HTTP_200_OK
 HTTP_201_CREATED
 HTTP_202_ACCEPTED
 HTTP_203_NON_AUTHORITATIVE_INFORMATION
@@ -131,7 +132,7 @@ HTTP_206_PARTIAL_CONTENT
 

 
Redirection - 3xx

 
This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request.

-
HTTP_300_MULTIPLE_CHOICES
+
HTTP_300_MULTIPLE_CHOICES
 HTTP_301_MOVED_PERMANENTLY
 HTTP_302_FOUND
 HTTP_303_SEE_OTHER
@@ -142,7 +143,7 @@ HTTP_307_TEMPORARY_REDIRECT
 

 
Client Error - 4xx

 
The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.

-
HTTP_400_BAD_REQUEST
+
HTTP_400_BAD_REQUEST
 HTTP_401_UNAUTHORIZED
 HTTP_402_PAYMENT_REQUIRED
 HTTP_403_FORBIDDEN
@@ -166,7 +167,7 @@ HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
 

 
Server Error - 5xx

 
Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.

-
HTTP_500_INTERNAL_SERVER_ERROR
+
HTTP_500_INTERNAL_SERVER_ERROR
 HTTP_501_NOT_IMPLEMENTED
 HTTP_502_BAD_GATEWAY
 HTTP_503_SERVICE_UNAVAILABLE
@@ -182,6 +183,7 @@ HTTP_511_NETWORD_AUTHENTICATION_REQUIRED
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/throttling.html b/api-guide/throttling.html
index 058b3556a..9c6bc8c65 100644
--- a/api-guide/throttling.html
+++ b/api-guide/throttling.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -102,6 +103,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/api-guide/views.html b/api-guide/views.html
index a5faa06fa..3a59b8c85 100644
--- a/api-guide/views.html
+++ b/api-guide/views.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -137,6 +138,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/css/drf-styles.css b/css/drf-styles.css
index fcc605324..ecbd415c1 100644
--- a/css/drf-styles.css
+++ b/css/drf-styles.css
@@ -10,6 +10,9 @@ body {
   padding-bottom: 40px;
 }
 
+pre {
+  font-size: 12px;
+}
 
 
 /* Preserve the spacing of the navbar across different screen sizes. */
diff --git a/css/prettify.css b/css/prettify.css
new file mode 100644
index 000000000..d437aff62
--- /dev/null
+++ b/css/prettify.css
@@ -0,0 +1,30 @@
+.com { color: #93a1a1; }
+.lit { color: #195f91; }
+.pun, .opn, .clo { color: #93a1a1; }
+.fun { color: #dc322f; }
+.str, .atv { color: #D14; }
+.kwd, .prettyprint .tag { color: #1e347b; }
+.typ, .atn, .dec, .var { color: teal; }
+.pln { color: #48484c; }
+
+.prettyprint {
+  padding: 8px;
+  background-color: #f7f7f9;
+  border: 1px solid #e1e1e8;
+}
+.prettyprint.linenums {
+  -webkit-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+     -moz-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+          box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin: 0 0 0 33px; /* IE indents via margin-left */
+}
+ol.linenums li {
+  padding-left: 12px;
+  color: #bebec5;
+  line-height: 20px;
+  text-shadow: 0 1px 0 #fff;
+}
\ No newline at end of file
diff --git a/index.html b/index.html
index 2960f40bf..5fe45038e 100644
--- a/index.html
+++ b/index.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -122,24 +123,24 @@
 
Installation

 
WARNING: These instructions will only become valid once this becomes the master version

 
Install using pip, including any optional packages you want...

-
pip install djangorestframework
+
pip install djangorestframework
 pip install markdown  # Recommended if using the browseable API.
 pip install pyyaml    # Required for yaml content-type support.
 

 
...or clone the project from github.

-
git clone git@github.com:tomchristie/django-rest-framework.git
+
git clone git@github.com:tomchristie/django-rest-framework.git
 cd django-rest-framework
 pip install -r requirements.txt
 pip install -r optionals.txt
 

 
Add djangorestframework to your INSTALLED_APPS.

-
INSTALLED_APPS = (
+
INSTALLED_APPS = (
     ...
     'djangorestframework',        
 )
 

 
If you're intending to use the browserable API you'll want to add REST framework's login and logout views.  Add the following to your root urls.py file.

-
urlpatterns = patterns('',
+
urlpatterns = patterns('',
     ...
     url(r'^api-auth/', include('djangorestframework.urls', namespace='djangorestframework'))
 )
@@ -184,10 +185,10 @@ pip install -r optionals.txt
 
Development

 
If you want to work on REST framework itself, clone the repository, then...

 
Build the docs:

-
./mkdocs.py
+
./mkdocs.py
 

 
Run the tests:

-
./djangorestframework/runtests/runtests.py
+
./djangorestframework/runtests/runtests.py
 

 
License

 
Copyright (c) 2011-2012, Tom Christie
@@ -217,6 +218,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

     ================================================== -->
     
     
+    
     
     
     
diff --git a/js/prettify.js b/js/prettify.js
new file mode 100644
index 000000000..eef5ad7e6
--- /dev/null
+++ b/js/prettify.js
@@ -0,0 +1,28 @@
+var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
+(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
+[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
+l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
+q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
+q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
+"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
+a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
+for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
+"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
+H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
+J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
+I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
+["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
+/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
+["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
+hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b=
+!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -108,6 +109,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/topics/credits.html b/topics/credits.html
index 9ca311f33..437bf1bde 100644
--- a/topics/credits.html
+++ b/topics/credits.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -99,43 +100,44 @@
           
Credits

 
The following people have helped make REST framework great.

 
    
-
  • Tom Christie  
    • 
-
  • Marko Tibold 
    • 
-
  • Paul Bagwell 
    • 
-
  • Sébastien Piquemal 
    • 
-
  • Carmen Wick 
    • 
-
  • Alex Ehlke 
    • 
-
  • Alen Mujezinovic 
    • 
-
  • Carles Barrobés 
    • 
-
  • Michael Fötsch 
    • 
-
  • David Larlet 
    • 
-
  • Andrew Straw 
    • 
-
  • Zeth 
    • 
-
  • Fernando Zunino 
    • 
-
  • Jens Alm 
    • 
-
  • Craig Blaszczyk 
    • 
-
  • Garcia Solero 
    • 
-
  • Tom Drummond 
    • 
-
  • Danilo Bargen 
    • 
-
  • Andrew McCloud 
    • 
-
  • Thomas Steinacher 
    • 
-
  • Meurig Freeman 
    • 
-
  • Anthony Nemitz 
    • 
-
  • Ewoud Kohl van Wijngaarden 
    • 
-
  • Michael Ding 
    • 
-
  • Mjumbe Poe 
    • 
-
  • Natim 
    • 
-
  • Sebastian Żurek 
    • 
-
  • Benoit C 
    • 
-
  • Chris Pickett 
    • 
-
  • Ben Timby 
    • 
-
  • Michele Lazzeri 
    • 
-
  • Camille Harang 
    • 
-
  • Paul Oswald 
    • 
-
  • Sean C. Farley 
    • 
-
  • Daniel Izquierdo 
    • 
-
  • Can Yavuz 
    • 
-
  • Shawn Lewis 
    • 
+
  • Tom Christie - tomchristie 
    • 
+
  • Marko Tibold - markotibold
    • 
+
  • Paul Bagwell - pbgwl
    • 
+
  • Sébastien Piquemal - sebpiq
    • 
+
  • Carmen Wick - cwick
    • 
+
  • Alex Ehlke - aehlke
    • 
+
  • Alen Mujezinovic - flashingpumpkin
    • 
+
  • Carles Barrobés - txels
    • 
+
  • Michael Fötsch - mfoetsch
    • 
+
  • David Larlet - david
    • 
+
  • Andrew Straw - astraw
    • 
+
  • Zeth - zeth
    • 
+
  • Fernando Zunino - fzunino
    • 
+
  • Jens Alm - ulmus
    • 
+
  • Craig Blaszczyk - jakul
    • 
+
  • Garcia Solero - garciasolero
    • 
+
  • Tom Drummond - devioustree
    • 
+
  • Danilo Bargen - gwrtheyrn
    • 
+
  • Andrew McCloud - amccloud
    • 
+
  • Thomas Steinacher - thomasst
    • 
+
  • Meurig Freeman - meurig
    • 
+
  • Anthony Nemitz - anemitz
    • 
+
  • Ewoud Kohl van Wijngaarden - ekohl
    • 
+
  • Michael Ding - yandy
    • 
+
  • Mjumbe Poe - mjumbewu
    • 
+
  • Natim - natim
    • 
+
  • Sebastian Żurek - sebzur
    • 
+
  • Benoit C - dzen
    • 
+
  • Chris Pickett - bunchesofdonald
    • 
+
  • Ben Timby - btimby
    • 
+
  • Michele Lazzeri - michelelazzeri-nextage
    • 
+
  • Camille Harang - mammique
    • 
+
  • Paul Oswald - poswald
    • 
+
  • Sean C. Farley - scfarley
    • 
+
  • Daniel Izquierdo - izquierdo
    • 
+
  • Can Yavuz - tschan
    • 
+
  • Shawn Lewis - shawnlewis
    • 
+
  • Alec Perkins - alecperkins
    • 
 

 
Many thanks to everyone who's contributed to the project.

 
Additional thanks

@@ -146,7 +148,7 @@
 
To contact the author directly:

 
         

       

@@ -156,6 +158,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/topics/csrf.html b/topics/csrf.html
index c8328b257..ef28d27d8 100644
--- a/topics/csrf.html
+++ b/topics/csrf.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -112,6 +113,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/topics/formoverloading.html b/topics/formoverloading.html
index bcf65c924..5f6225f47 100644
--- a/topics/formoverloading.html
+++ b/topics/formoverloading.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -105,7 +106,7 @@
 
Overloading the HTTP method

 
TODO: Preamble.  Note that this is the same strategy as is used in Ruby on Rails.

 
For example, given the following form:

-
<form action="/news-items/5" method="POST">
+
<form action="/news-items/5" method="POST">
     <input type="hidden" name="_method" value="DELETE">
 </form>
 

@@ -113,7 +114,7 @@
 
Overloading the HTTP content type

 
Browser-based submission of content types other than form are supported by using form fields named _content and _content_type:

 
For example, given the following form:

-
<form action="/news-items/5" method="PUT">
+
<form action="/news-items/5" method="PUT">
     <input type="hidden" name="_content_type" value="application/json">
     <input name="_content" value="{'count': 1}">
 </form>
@@ -131,6 +132,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html
index ae880e622..95f330827 100644
--- a/tutorial/1-serialization.html
+++ b/tutorial/1-serialization.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -108,26 +109,27 @@
 
This tutorial will walk you through the building blocks that make up REST framework.   It'll take a little while to get through, but it'll give you a comprehensive understanding of how everything fits together.

 
Setting up a new environment

 
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.

-
mkdir ~/env
+
+mkdir ~/env
 virtualenv --no-site-packages ~/env/tutorial
 source ~/env/tutorial/bin/activate
 

 
Now that we're inside a virtualenv environment, we can install our package requirements.

-
pip install django
+
pip install django
 pip install djangorestframework
 

 
Note: To exit the virtualenv environment at any time, just type deactivate.  For more information see the virtualenv documentation.

 
Getting started

 
Okay, we're ready to get coding.
 To get started, let's create a new project to work with.

-
django-admin.py startproject tutorial
+
django-admin.py startproject tutorial
 cd tutorial
 

 
Once that's done we can create an app that we'll use to create a simple Web API.

-
python manage.py startapp blog
+
python manage.py startapp blog
 

 
The simplest way to get up and running will probably be to use an sqlite3 database for the tutorial.  Edit the tutorial/settings.py file, and set the default database "ENGINE" to "sqlite3", and "NAME" to "tmp.db".

-
DATABASES = {
+
DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',
         'NAME': 'tmp.db',
@@ -139,21 +141,21 @@ cd tutorial
 }
 

 
We'll also need to add our new blog app and the djangorestframework app to INSTALLED_APPS.

-
INSTALLED_APPS = (
+
INSTALLED_APPS = (
     ...
     'djangorestframework',
     'blog'
 )
 

 
We also need to wire up the root urlconf, in the tutorial/urls.py file, to include our blog views.

-
urlpatterns = patterns('',
+
urlpatterns = patterns('',
     url(r'^', include('blog.urls')),
 )
 

 
Okay, we're ready to roll.

 
Creating a model to work with

 
For the purposes of this tutorial we're going to start by creating a simple Comment model that is used to store comments against a blog post.  Go ahead and edit the  blog app's models.py file.

-
from django.db import models
+
from django.db import models
 
 class Comment(models.Model):
     email = models.EmailField()
@@ -161,11 +163,11 @@ class Comment(models.Model):
     created = models.DateTimeField(auto_now_add=True)
 

 
Don't forget to sync the database for the first time.

-
python manage.py syncdb
+
python manage.py syncdb
 

 
Creating a Serializer class

 
We're going to create a simple Web API that we can use to edit these comment objects with.  The first thing we need is a way of serializing and deserializing the objects into representations such as json.  We do this by declaring serializers, that work very similarly to Django's forms.  Create a file in the project named serializers.py and add the following.

-
from blog import models
+
from blog import models
 from djangorestframework import serializers
 
 class CommentSerializer(serializers.Serializer):
@@ -189,10 +191,10 @@ class CommentSerializer(serializers.Serializer):
 

 
Working with Serializers

 
Before we go any further we'll familiarise ourselves with using our new Serializer class.  Let's drop into the Django shell.

-
python manage.py shell
+
python manage.py shell
 

 
Okay, once we've got a few imports out of the way, we'd better create a few comments to work with.

-
from blog.models import Comment
+
from blog.models import Comment
 from blog.serializers import CommentSerializer
 from djangorestframework.renderers import JSONRenderer
 from djangorestframework.parsers import JSONParser
@@ -205,20 +207,20 @@ c2.save()
 c3.save()
 

 
We've now got a few comment instances to play with.  Let's take a look at serializing one of those instances.

-
serializer = CommentSerializer(instance=c1)
+
serializer = CommentSerializer(instance=c1)
 serializer.data
 # {'email': u'leila@example.com', 'content': u'nothing to say', 'created': datetime.datetime(2012, 8, 22, 16, 20, 9, 822774, tzinfo=<UTC>)}
 

 
At this point we've translated the model instance into python native datatypes.  To finalise the serialization process we render the data into json.

-
stream = JSONRenderer().render(serializer.data)
+
stream = JSONRenderer().render(serializer.data)
 stream
 # '{"email": "leila@example.com", "content": "nothing to say", "created": "2012-08-22T16:20:09.822"}'
 

 
Deserialization is similar.  First we parse a stream into python native datatypes... 

-
data = JSONParser().parse(stream)
+
data = JSONParser().parse(stream)
 

 
...then we restore those native datatypes into to a fully populated object instance.

-
serializer = CommentSerializer(data)
+
serializer = CommentSerializer(data)
 serializer.is_valid()
 # True
 serializer.object
@@ -229,7 +231,7 @@ serializer.object
 
Let's see how we can write some API views using our new Serializer class.
 We'll start off by creating a subclass of HttpResponse that we can use to render any data we return into json.

 
Edit the blog/views.py file, and add the following.

-
from blog.models import Comment
+
from blog.models import Comment
 from blog.serializers import CommentSerializer
 from djangorestframework.renderers import JSONRenderer
 from djangorestframework.parsers import JSONParser
@@ -246,7 +248,7 @@ class JSONResponse(HttpResponse):
         super(JSONResponse, self).__init__(content, **kwargs)
 

 
The root of our API is going to be a view that supports listing all the existing comments, or creating a new comment.

-
def comment_root(request):
+
def comment_root(request):
     """
     List all comments, or create a new comment.
     """
@@ -266,7 +268,7 @@ class JSONResponse(HttpResponse):
             return JSONResponse(serializer.error_data, status=400)
 

 
We'll also need a view which corrosponds to an individual comment, and can be used to retrieve, update or delete the comment.

-
def comment_instance(request, pk):
+
def comment_instance(request, pk):
     """
     Retrieve, update or delete a comment instance.
     """
@@ -294,7 +296,7 @@ class JSONResponse(HttpResponse):
         return HttpResponse(status=204)
 

 
Finally we need to wire these views up, in the tutorial/urls.py file.

-
from django.conf.urls import patterns, url
+
from django.conf.urls import patterns, url
 
 urlpatterns = patterns('blog.views',
     url(r'^$', 'comment_root'),
@@ -317,6 +319,7 @@ urlpatterns = patterns('blog.views',
     ================================================== -->
     
     
+    
     
     
     
diff --git a/tutorial/2-requests-and-responses.html b/tutorial/2-requests-and-responses.html
index 67e4e7d70..110df90f2 100644
--- a/tutorial/2-requests-and-responses.html
+++ b/tutorial/2-requests-and-responses.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -107,12 +108,12 @@
 Let's introduce a couple of essential building blocks.

 
Request objects

 
REST framework intoduces a Request object that extends the regular HttpRequest, and provides more flexible request parsing.  The core functionality of the Request object is the request.DATA attribute, which is similar to request.POST, but more useful for working with Web APIs.

-
request.POST  # Only handles form data.  Only works for 'POST' method.
+
request.POST  # Only handles form data.  Only works for 'POST' method.
 request.DATA  # Handles arbitrary data.  Works any HTTP request with content.
 

 
Response objects

 
REST framework also introduces a Response object, which is a type of TemplateResponse that takes unrendered content and uses content negotiation to determine the correct content type to return to the client.

-
return Response(data)  # Renders to content type as requested by the client.
+
return Response(data)  # Renders to content type as requested by the client.
 

 
Status codes

 
Using numeric HTTP status codes in your views doesn't always make for obvious reading, and it's easy to not notice if you get an error code wrong.  REST framework provides more explicit identifiers for each status code, such as HTTP_400_BAD_REQUEST in the status module.  It's a good idea to use these throughout rather than using numeric identifiers.

@@ -127,7 +128,7 @@ request.DATA  # Handles arbitrary data.  Works any HTTP request with content.
 
Pulling it all together

 
Okay, let's go ahead and start using these new components to write a few views. 

 
We don't need our JSONResponse class anymore, so go ahead and delete that.  Once that's done we can start refactoring our views slightly.

-
from blog.models import Comment
+
from blog.models import Comment
 from blog.serializers import CommentSerializer
 from djangorestframework import status
 from djangorestframework.decorators import api_view
@@ -153,7 +154,7 @@ def comment_root(request):
             return Response(serializer.error_data, status=status.HTTP_400_BAD_REQUEST)
 

 
Our instance view is an improvement over the previous example.  It's a little more concise, and the code now feels very similar to if we were working with the Forms API.  We're also using named status codes, which makes the response meanings more obvious.

-
@api_view(['GET', 'PUT', 'DELETE'])
+
@api_view(['GET', 'PUT', 'DELETE'])
 def comment_instance(request, pk):
     """
     Retrieve, update or delete a comment instance.
@@ -185,13 +186,13 @@ def comment_instance(request, pk):
 
Adding optional format suffixes to our URLs

 
To take advantage of the fact that our responses are no longer hardwired to a single content type let's add support for format suffixes to our API endpoints. Using format suffixes gives us URLs that explicitly refer to a given format, and means our API will be able to handle URLs such as http://example.com/api/items/4.json.

 
Start by adding a format keyword argument to both of the views, like so.

-
def comment_root(request, format=None):
+
def comment_root(request, format=None):
 

 
and

-
def comment_instance(request, pk, format=None):
+
def comment_instance(request, pk, format=None):
 

 
Now update the urls.py file slightly, to append a set of format_suffix_patterns in addition to the existing URLs.

-
from django.conf.urls import patterns, url
+
from django.conf.urls import patterns, url
 from djangorestframework.urlpatterns import format_suffix_patterns
 
 urlpatterns = patterns('blogpost.views',
@@ -218,6 +219,7 @@ urlpatterns = format_suffix_patterns(urlpatterns)
     ================================================== -->
     
     
+    
     
     
     
diff --git a/tutorial/3-class-based-views.html b/tutorial/3-class-based-views.html
index a7f6e15ea..87c6c453c 100644
--- a/tutorial/3-class-based-views.html
+++ b/tutorial/3-class-based-views.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -101,7 +102,7 @@
 
We can also write our API views using class based views, rather than function based views.  As we'll see this is a powerful pattern that allows us to reuse common functionality, and helps us keep our code DRY.

 
Rewriting our API using class based views

 
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.models import Comment
 from blog.serializers import CommentSerializer
 from django.http import Http404
 from djangorestframework.views import APIView
@@ -128,7 +129,7 @@ class CommentRoot(APIView):
 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. 

-
class CommentInstance(APIView):
+
class CommentInstance(APIView):
     """
     Retrieve, update or delete a comment instance.
     """
@@ -166,7 +167,7 @@ Okay, we're done.  If you run the development server everything should be workin
 
One of the big wins of using class based views is that it allows us to easily compose reusable bits of behaviour.

 
The create/retrieve/update/delete operations that we've been using so far are going to be pretty simliar for any model-backed API views we create.  Those bits of common behaviour are implemented in REST framework's mixin classes.

 
Let's take a look at how we can compose our views by using the mixin classes.

-
from blog.models import Comment
+
from blog.models import Comment
 from blog.serializers import CommentSerializer
 from djangorestframework import mixins
 from djangorestframework import generics
@@ -187,7 +188,7 @@ comment_root = CommentRoot.as_view()
 

 
We'll take a moment to examine exactly what's happening here - We're building our view using MultipleObjectBaseView, and adding in ListModelMixin and CreateModelMixin.

 
The base class provides the core functionality, and the mixin classes provide the .list() and .create() actions.  We're then explictly binding the get and post methods to the appropriate actions.  Simple enough stuff so far.

-
class CommentInstance(mixins.RetrieveModelMixin,
+
class CommentInstance(mixins.RetrieveModelMixin,
                       mixins.UpdateModelMixin,
                       mixins.DestroyModelMixin,
                       generics.SingleObjectBaseView):
@@ -208,7 +209,7 @@ comment_instance = CommentInstance.as_view()
 
Pretty similar.  This time we're using the SingleObjectBaseView class to provide the core functionality, and adding in mixins to provide the .retrieve(), .update() and .destroy() actions.

 
Using generic class based views

 
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.models import Comment
 from blog.serializers import CommentSerializer
 from djangorestframework import generics
 
@@ -234,6 +235,7 @@ comment_instance = CommentInstance.as_view()
     ================================================== -->
     
     
+    
     
     
     
diff --git a/tutorial/4-authentication-permissions-and-throttling.html b/tutorial/4-authentication-permissions-and-throttling.html
index e457c2d09..dc8dd5dc6 100644
--- a/tutorial/4-authentication-permissions-and-throttling.html
+++ b/tutorial/4-authentication-permissions-and-throttling.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -102,6 +103,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/tutorial/5-relationships-and-hyperlinked-apis.html b/tutorial/5-relationships-and-hyperlinked-apis.html
index e458ff388..b553e0aa1 100644
--- a/tutorial/5-relationships-and-hyperlinked-apis.html
+++ b/tutorial/5-relationships-and-hyperlinked-apis.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -108,6 +109,7 @@
     ================================================== -->
     
     
+    
     
     
     
diff --git a/tutorial/6-resource-orientated-projects.html b/tutorial/6-resource-orientated-projects.html
index 6c893db6e..9e13bfb70 100644
--- a/tutorial/6-resource-orientated-projects.html
+++ b/tutorial/6-resource-orientated-projects.html
@@ -7,6 +7,7 @@
     
 
     
+    
     
     
     
@@ -15,7 +16,7 @@
     
-  
+  
 
     

       

@@ -96,7 +97,7 @@
 
         

           
serializers.py

-
class BlogPostSerializer(URLModelSerializer):
+
class BlogPostSerializer(URLModelSerializer):
     class Meta:
         model = BlogPost
 
@@ -105,7 +106,7 @@ class CommentSerializer(URLModelSerializer):
         model = Comment
 

 
resources.py

-
class BlogPostResource(ModelResource):
+
class BlogPostResource(ModelResource):
     serializer_class = BlogPostSerializer
     model = BlogPost
     permissions = [AdminOrAnonReadonly()]
@@ -118,7 +119,7 @@ class CommentResource(ModelResource):
     throttles = [AnonThrottle(rate='5/min')]
 

 
Now that we're using Resources rather than Views, we don't need to design the urlconf ourselves.  The conventions for wiring up resources into views and urls are handled automatically.  All we need to do is register the appropriate resources with a router, and let it do the rest.  Here's our re-wired urls.py file.

-
from blog import resources
+
from blog import resources
 from djangorestframework.routers import DefaultRouter
 
 router = DefaultRouter()
@@ -145,6 +146,7 @@ urlpatterns = router.urlpatterns
     ================================================== -->
     
     
+