diff --git a/api-guide/authentication.html b/api-guide/authentication.html index 84d8441c2..d70a5bee6 100644 --- a/api-guide/authentication.html +++ b/api-guide/authentication.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

authentication.py

+
+

authentication.py

Authentication

Auth needs to be pluggable.

@@ -202,20 +203,17 @@ print token.key

Custom authentication policies

To implement a custom authentication policy, subclass BaseAuthentication and override the .authenticate(self, request) method. The method should return a two-tuple of (user, auth) if authentication succeeds, or None otherwise.

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/content-negotiation.html b/api-guide/content-negotiation.html index c61b31532..3660ee664 100644 --- a/api-guide/content-negotiation.html +++ b/api-guide/content-negotiation.html @@ -19,6 +19,8 @@ +
+
@@ -91,41 +93,37 @@
-
+
+
+
-
-
+
+
-
-
-

negotiation.py

+
+

negotiation.py

Content negotiation

HTTP has provisions for several mechanisms for "content negotiation" - the process of selecting the best representation for a given response when there are multiple representations available.

— RFC 2616, Fielding et al.

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/exceptions.html b/api-guide/exceptions.html index b27bfd4e1..9a2702bd0 100644 --- a/api-guide/exceptions.html +++ b/api-guide/exceptions.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

exceptions.py

+
+

exceptions.py

Exceptions

Exceptions… allow error handling to be organized cleanly in a central or high-level place within the program structure.

@@ -164,20 +165,17 @@ Content-Length: 42

Signature: Throttled(wait=None, detail=None)

Raised when an incoming request fails the throttling checks.

By default this exception results in a response with the HTTP status code "429 Too Many Requests".

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/fields.html b/api-guide/fields.html index 88ddb70bb..88bcdb4c6 100644 --- a/api-guide/fields.html +++ b/api-guide/fields.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

fields.py

+
+

fields.py

Serializer fields

Flat is better than nested.

— The Zen of Python

-

Note: The serializer fields are declared in fields.py, but by convention you should import them using from rest_framework import serializers and refer to fields as serializers.<FieldName>.

Serializer fields handle converting between primative values and internal datatypes. They also deal with validating input values, as well as retrieving and setting the values from their parent objects.

+
+

Note: The serializer fields are declared in fields.py, but by convention you should import them using from rest_framework import serializers and refer to fields as serializers.<FieldName>.

+

Generic Fields

Field

A generic, read-only field. You can use this field for any attribute that does not need to support write operations.

@@ -156,20 +159,17 @@

HyperlinkedRelatedField

ManyHyperlinkedRelatedField

HyperLinkedIdentityField

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/format-suffixes.html b/api-guide/format-suffixes.html index ee51bd42d..c6bee65ea 100644 --- a/api-guide/format-suffixes.html +++ b/api-guide/format-suffixes.html @@ -19,6 +19,8 @@ +
+
@@ -91,42 +93,38 @@
-
+
+
+
-
-
+
+
+ +
-
-
-

urlpatterns.py

+
+

urlpatterns.py

Format suffixes

Section 6.2.1 does not say that content negotiation should be used all the time.

— Roy Fielding, REST discuss mailing list

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/generic-views.html b/api-guide/generic-views.html index 9b7d5f95f..308450850 100644 --- a/api-guide/generic-views.html +++ b/api-guide/generic-views.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

mixins.py +

+

mixins.py generics.py

Generic views

@@ -200,20 +201,17 @@

Provides a .update(request, *args, **kwargs) method, that implements updating and saving an existing model instance.

DestroyModelMixin

Provides a .destroy(request, *args, **kwargs) method, that implements deletion of an existing model instance.

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/pagination.html b/api-guide/pagination.html index a0f9c46d2..2d810f140 100644 --- a/api-guide/pagination.html +++ b/api-guide/pagination.html @@ -19,6 +19,8 @@ +
+
@@ -91,26 +93,25 @@
-
+
+
+
-
-
- -
-
-
-
-

pagination.py

+
+

pagination.py

Pagination

Django provides a few classes that help you manage paginated data – that is, data that’s split across several pages, with “Previous/Next” links.

@@ -209,20 +210,17 @@ class CustomPaginationSerializer(pagination.BasePaginationSerializer): results_field = 'objects' -
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/parsers.html b/api-guide/parsers.html index 9e8f5183c..c2935340f 100644 --- a/api-guide/parsers.html +++ b/api-guide/parsers.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
- +
-
-
-

parsers.py

+
+

parsers.py

Parsers

Machine interacting web services tend to use more @@ -126,20 +127,17 @@ sending more complex data than simple forms

FormParser

MultiPartParser

Custom parsers

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/permissions.html b/api-guide/permissions.html index d723bacaa..886df5ed1 100644 --- a/api-guide/permissions.html +++ b/api-guide/permissions.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

permissions.py

+
+

permissions.py

Permissions

Authentication or identification by itself is not usually sufficient to gain access to information or code. For that, the entity requesting access must have authorization.

@@ -179,20 +180,17 @@ def example_view(request, format=None):

Custom permissions

To implement a custom permission, override BasePermission and implement the .has_permission(self, request, obj=None) method.

The method should return True if the request should be granted access, and False otherwise.

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/renderers.html b/api-guide/renderers.html index 8bdf01c06..de64957b7 100644 --- a/api-guide/renderers.html +++ b/api-guide/renderers.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

renderers.py

+
+

renderers.py

Renderers

Before a TemplateResponse instance can be returned to the client, it must be rendered. The rendering process takes the intermediate representation of template and context, and turns it into the final byte stream that can be served to the client.

@@ -238,20 +239,17 @@ def list_users(request):

For the purposes of many Web APIs, simple JSON responses with hyperlinked relations may be sufficient. If you want to fully embrace RESTful design and HATEOAS you'll neeed to consider the design and usage of your media types in more detail.

In the words of Roy Fielding, "A REST API should spend almost all of its descriptive effort in defining the media type(s) used for representing resources and driving application state, or in defining extended relation names and/or hypertext-enabled mark-up for existing standard media types.".

For good examples of custom media types, see GitHub's use of a custom application/vnd.github+json media type, and Mike Amundsen's IANA approved application/vnd.collection+json JSON-based hypermedia.

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/requests.html b/api-guide/requests.html index ee0eca8a5..06bb02d9b 100644 --- a/api-guide/requests.html +++ b/api-guide/requests.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
- +
-
-
-

request.py

+
+

request.py

Requests

If you're doing REST-based web service stuff ... you should ignore request.POST.

@@ -151,20 +152,17 @@

request.authentication should be set to a list of Authentication instances that can be used to authenticate the request.

request.authentication may no longer be altered once request.user or request.auth have been accessed.

If you're using the rest_framework.views.View class... [TODO]

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/responses.html b/api-guide/responses.html index 6c9a147d8..ed6d34a51 100644 --- a/api-guide/responses.html +++ b/api-guide/responses.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

response.py

+
+

response.py

Responses

Unlike basic HttpResponse objects, TemplateResponse objects retain the details of the context that was provided by the view to compute the response. The final output of the response is not computed until it is needed, later in the response process.

@@ -166,20 +167,17 @@ response['Cache-Control'] = 'no-cache'

.accepted_media_type

The media type that was selected by the content negotiation stage.

Set automatically by the APIView or @api_view immediately before the response is returned from the view.

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/reverse.html b/api-guide/reverse.html index 77eeaa13b..335c3bb43 100644 --- a/api-guide/reverse.html +++ b/api-guide/reverse.html @@ -19,6 +19,8 @@ +
+
@@ -91,24 +93,23 @@
-
+
+
+
-
-
- -
-
-
-
-

reverse.py

+
+

reverse.py

Returning URLs

The central feature that distinguishes the REST architectural style from other network-based styles is its emphasis on a uniform interface between components.

@@ -143,20 +144,17 @@ class APIRootView(APIView):

reverse_lazy

Signature: reverse_lazy(viewname, request, *args, **kwargs)

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

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/serializers.html b/api-guide/serializers.html index 30b4cfdf4..08a672c49 100644 --- a/api-guide/serializers.html +++ b/api-guide/serializers.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

serializers.py

+
+

serializers.py

Serializers

Expanding the usefulness of the serializers is something that we would @@ -308,20 +309,17 @@ The ModelSerializer class lets you automatically create a Serialize def get_field(self, model_field): return Field() -

-
-
+
+
+
+
-
+
- + diff --git a/api-guide/settings.html b/api-guide/settings.html index a529a72c8..db21e7084 100644 --- a/api-guide/settings.html +++ b/api-guide/settings.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

settings.py

+
+

settings.py

Settings

Namespaces are one honking great idea - let's do more of those!

@@ -211,20 +212,17 @@ print api_settings.DEFAULT_AUTHENTICATION

Default: 'accept'

URL_FORMAT_OVERRIDE

Default: 'format'

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/status-codes.html b/api-guide/status-codes.html index fd297bc95..1761854dc 100644 --- a/api-guide/status-codes.html +++ b/api-guide/status-codes.html @@ -19,6 +19,8 @@ +
+
@@ -91,27 +93,26 @@
-
+
+
+
-
-
- -
-
-
-
-

status.py

+
+

status.py

Status Codes

418 I'm a teapot - Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.

@@ -187,20 +188,17 @@ HTTP_504_GATEWAY_TIMEOUT HTTP_505_HTTP_VERSION_NOT_SUPPORTED HTTP_511_NETWORD_AUTHENTICATION_REQUIRED -
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/throttling.html b/api-guide/throttling.html index f7b3ea877..c31337cb5 100644 --- a/api-guide/throttling.html +++ b/api-guide/throttling.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
-

throttling.py

+
+

throttling.py

Throttling

HTTP/1.1 420 Enhance Your Calm

@@ -227,20 +228,17 @@ class UploadView(APIView):

Custom throttles

To create a custom throttle, override BaseThrottle and implement .allow_request(request). The method should return True if the request should be allowed, and False otherwise.

Optionally you may also override the .wait() method. If implemented, .wait() should return a recomended number of seconds to wait before attempting the next request, or None. The .wait() method will only be called if .check_throttle() has previously returned False.

-
-
-
+
+
+
+
-
+
- + diff --git a/api-guide/views.html b/api-guide/views.html index 3406f3998..8d5fc7476 100644 --- a/api-guide/views.html +++ b/api-guide/views.html @@ -19,6 +19,8 @@ +
+
@@ -91,27 +93,26 @@
-
+
+
+
-
-
- -
-
-
-
-

decorators.py views.py

+
+

decorators.py views.py

Class Based Views

Django's class based views are a welcome departure from the old-style views.

@@ -191,20 +192,17 @@ This method is used to enforce permissions and throttling, and perform content n

REST framework also gives you to work with regular function based views...

[TODO]

-
-
-
+
+
+
+
-
+
- + diff --git a/css/default.css b/css/default.css index 8401687d5..742a41477 100644 --- a/css/default.css +++ b/css/default.css @@ -1,15 +1,5 @@ /* Set the body padding-top when above 980px to push the content down from below the navbar, which is fixed at >980px screen widths. */ -@media (min-width: 980px) { - body { - padding-top: 71px; - } -} - -body { - padding-bottom: 40px; -} - pre { font-size: 12px; } @@ -61,28 +51,9 @@ a.github:hover { text-decoration: none; } -/* Footer */ -/* -.footer p { - text-align: center; - color: gray; - border-top: 1px solid #DDD; - padding-top: 10px; -} - -.footer a { - color: gray; - font-weight: bold; -} - -.footer a:hover { - color: gray; -} -*/ - /* */ body hr { - border-top: 1px dotted #A30000 + border-top: 1px dotted #A30000; } /* Force TOC text to not overrun */ @@ -100,7 +71,7 @@ pre { /* Preserve the spacing of the navbar across different screen sizes. */ .navbar-inner { - padding: 5px 0; + /*padding: 5px 0;*/ } @media (max-width: 979px) { @@ -194,8 +165,9 @@ body{ color: white; } -.nav-list > .active > a, .nav-list > .active > a:hover { - background: #2c2c2c; +.nav-list > .active > a, .navbar .navbar-inner .nav li a:hover { + background:#212121; + color:white; } .navbar .navbar-inner .dropdown-menu li a, .navbar .navbar-inner .dropdown-menu li{ @@ -233,3 +205,40 @@ body a:hover{ } } + +/* sticky footer and footer */ +html, body { + height: 100%; +} +.wrapper { + min-height: 100%; + height: auto !important; + height: 100%; + margin: 0 auto -60px; +} + +.body-content{ + padding-top: 70px; + padding-bottom: 70px; +} + +footer, .push { + height: 60px; /* .push must be the same height as .footer */ +} + + +footer p { + text-align: center; + color: gray; + border-top: 1px solid #DDD; + padding-top: 10px; +} + +footer a { + color: gray; + font-weight: bold; +} + +footer a:hover { + color: gray; +} diff --git a/index.html b/index.html index 653c1a021..454bb555b 100644 --- a/index.html +++ b/index.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
-
-
- +
+

Travis build image

Django REST framework

@@ -229,20 +230,17 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-
-
-
+
+
+
+
-
+
- + diff --git a/topics/browsable-api.html b/topics/browsable-api.html index 5f93da4aa..cb7931c4e 100644 --- a/topics/browsable-api.html +++ b/topics/browsable-api.html @@ -19,6 +19,8 @@ +
+
@@ -91,25 +93,24 @@
-
+
+
+
-
-
- -
-
-
-
-

Working with the Browsable API

+
+

Working with the Browsable API

API may stand for Application Programming Interface, but humans have to be able to read the APIs, too; someone has to do the programming. Django REST Framework supports generating human-friendly HTML output for each resource when the HTML format is requested. These pages allow for easy browsing of resources, as well as forms for submitting data to the resources using POST, PUT, and DELETE.

URLs

If you include fully-qualified URLs in your resource output, they will be 'urlized' and made clickable for easy browsing by humans. The rest_framework package includes a reverse helper for this purpose.

@@ -169,20 +170,17 @@

Not using base.html

For more advanced customization, such as not having a Bootstrap basis or tighter integration with the rest of your site, you can simply choose not to have api.html extend base.html. Then the page content and capabilities are entirely up to you.

-
-
-
+
+
+
+
-
+
- + diff --git a/topics/changelog.html b/topics/changelog.html index 886bff437..ec5080d11 100644 --- a/topics/changelog.html +++ b/topics/changelog.html @@ -19,6 +19,8 @@ +
+
@@ -91,15 +93,14 @@
-
+
+
+
-
-
- -
-
- +
-
-
-

Release Notes

+
+

Release Notes

2.0.0

TODO: Explain REST framework 2.0

0.4.0

@@ -231,20 +232,17 @@
  • Initial release.
-
-
-
+
+
+
+
-
+
- + diff --git a/topics/contributing.html b/topics/contributing.html index a91d2dbf2..d77204fd4 100644 --- a/topics/contributing.html +++ b/topics/contributing.html @@ -19,6 +19,8 @@ +
+
@@ -91,25 +93,24 @@
-
+
+
+
-
-
- -
-
-
-
-

Contributing to REST framework

+
+

Contributing to REST framework

The world can only really be changed one piece at a time. The art is picking that piece.

— Tim Berners-Lee

@@ -118,20 +119,17 @@

Building the docs

Managing compatibility issues

Describe compat module

-
-
-
+
+
+
+
-
+
- + diff --git a/topics/credits.html b/topics/credits.html index 90ae9f986..1d92305d1 100644 --- a/topics/credits.html +++ b/topics/credits.html @@ -19,6 +19,8 @@ +
+
@@ -91,24 +93,23 @@
-
+
+
+
-
-
- -
-
-
-
-

Credits

+
+

Credits

The following people have helped make REST framework great.

-
-
-
+
+
+
+
-
+
- + diff --git a/topics/csrf.html b/topics/csrf.html index ea347b225..1305d3fcb 100644 --- a/topics/csrf.html +++ b/topics/csrf.html @@ -19,6 +19,8 @@ +
+
@@ -91,22 +93,21 @@
-
+
+
+
-
-
+
+
-
-
-

Working with AJAX and CSRF

+
+

Working with AJAX and CSRF

"Take a close look at possible CSRF / XSRF vulnerabilities on your own websites. They're the worst kind of vulnerability -- very easy to exploit by attackers, yet not so intuitively easy to understand for software developers, at least until you've been bitten by one."

— Jeff Atwood

@@ -116,20 +117,17 @@
  • Explain defered CSRF style used by REST framework
  • Why you should use Django's standard login/logout views, and not REST framework view
    • -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/topics/formoverloading.html b/topics/formoverloading.html index d372b6ac1..e7b301a82 100644 --- a/topics/formoverloading.html +++ b/topics/formoverloading.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,27 +93,26 @@
    -
    +
    +
    +
    -
    -
    - -
    -
    -
    -
    -

    Browser hacks

    +
    +

    Browser hacks

    "There are two noncontroversial uses for overloaded POST. The first is to simulate HTTP's uniform interface for clients like web browsers that don't support PUT or DELETE"

    — RESTful Web Services, Leonard Richardson & Sam Ruby.

    @@ -137,20 +138,17 @@

    URL based format suffixes

    Doesn't HTML5 support PUT and DELETE forms?

    Nope. It was at one point intended to support PUT and DELETE forms, but was later dropped from the spec. There remains ongoing discussion about adding support for PUT and DELETE, as well as how to support content types other than form-encoded data.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/topics/rest-hypermedia-hateoas.html b/topics/rest-hypermedia-hateoas.html index 6cd35b8ff..d046ff664 100644 --- a/topics/rest-hypermedia-hateoas.html +++ b/topics/rest-hypermedia-hateoas.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,23 +93,22 @@
    -
    +
    +
    +
    -
    -
    - -
    -
    -
    -
    -

    REST, Hypermedia & HATEOAS

    +
    +

    REST, Hypermedia & HATEOAS

    You keep using that word "REST". I do not think it means what you think it means.

    — Mike Amundsen, REST fest 2012 keynote.

    @@ -132,20 +133,17 @@ the Design of Network-based Software Architectures.

    REST framework also includes serialization and parser/renderer components that make it easy to build appropriate media types, hyperlinked relations for building well-connected systems, and great support for content negotiation.

    What REST framework doesn't provide.

    What REST framework doesn't do is give you is machine readable hypermedia formats such as Collection+JSON by default, or the ability to auto-magically create HATEOAS style APIs. Doing so would involve making opinionated choices about API design that should really remain outside of the framework's scope.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html index 6d1243bef..47a9c92b9 100644 --- a/tutorial/1-serialization.html +++ b/tutorial/1-serialization.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,15 +93,14 @@
    -
    +
    +
    +
    -
    -
    - -
    -
    -
    -
    -

    Tutorial 1: Serialization

    +
    +

    Tutorial 1: Serialization

    Introduction

    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

    @@ -328,20 +329,17 @@ urlpatterns = patterns('blog.views',

    We're doing okay so far, we've got a serialization API that feels pretty similar to Django's Forms API, and some regular Django views.

    Our API views don't do anything particularly special at the moment, beyond serve json responses, and there's some error handling edge cases we'd still like to clean up, but it's a functioning Web API.

    We'll see how we can start to improve things in part 2 of the tutorial.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/tutorial/2-requests-and-responses.html b/tutorial/2-requests-and-responses.html index 675951d8d..0dc7d7c00 100644 --- a/tutorial/2-requests-and-responses.html +++ b/tutorial/2-requests-and-responses.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,15 +93,14 @@
    -
    +
    +
    +
    -
    -
    - -
    -
    -
    -
    -

    Tutorial 2: Requests and Responses

    +
    +

    Tutorial 2: Requests and Responses

    From this point we're going to really start covering the core of REST framework. Let's introduce a couple of essential building blocks.

    Request objects

    @@ -224,20 +225,17 @@ urlpatterns = format_suffix_patterns(urlpatterns)

    See the browsable api topic for more information about the browsable API feature and how to customize it.

    What's next?

    In tutorial part 3, we'll start using class based views, and see how generic views reduce the amount of code we need to write.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/tutorial/3-class-based-views.html b/tutorial/3-class-based-views.html index fe4d77ae4..b100e9558 100644 --- a/tutorial/3-class-based-views.html +++ b/tutorial/3-class-based-views.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,25 +93,24 @@
    -
    +
    +
    +
    -
    -
    - -
    -
    -
    -
    -

    Tutorial 3: Class Based Views

    +
    +

    Tutorial 3: Class Based Views

    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.

    @@ -238,20 +239,17 @@ class CommentInstance(generics.RetrieveUpdateDestroyAPIView):

    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, 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.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/tutorial/4-authentication-permissions-and-throttling.html b/tutorial/4-authentication-permissions-and-throttling.html index 59622a932..5a8300645 100644 --- a/tutorial/4-authentication-permissions-and-throttling.html +++ b/tutorial/4-authentication-permissions-and-throttling.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,37 +93,33 @@
    -
    +
    +
    +
    -
    -
    +
    +
    -
    -
    -

    Tutorial 4: Authentication & Permissions

    +
    +

    Tutorial 4: Authentication & Permissions

    Nothing to see here. Onwards to part 5.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/tutorial/5-relationships-and-hyperlinked-apis.html b/tutorial/5-relationships-and-hyperlinked-apis.html index 2595b987e..305724092 100644 --- a/tutorial/5-relationships-and-hyperlinked-apis.html +++ b/tutorial/5-relationships-and-hyperlinked-apis.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,22 +93,21 @@
    -
    +
    +
    +
    -
    -
    +
    +
    -
    -
    -

    Tutorial 5 - Relationships & Hyperlinked APIs

    +
    +

    Tutorial 5 - Relationships & Hyperlinked APIs

    TODO

    • Create BlogPost model
      • @@ -114,20 +115,17 @@
    • Demonstrate and describe hyperlinked relationships

    Onwards to part 6.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - + diff --git a/tutorial/6-resource-orientated-projects.html b/tutorial/6-resource-orientated-projects.html index 962625daa..0da13abc5 100644 --- a/tutorial/6-resource-orientated-projects.html +++ b/tutorial/6-resource-orientated-projects.html @@ -19,6 +19,8 @@ +
    +
    @@ -91,27 +93,26 @@
    -
    +
    +
    +
    -
    -
    - -
    -
    -
    -
    -

    Tutorial 6 - Resources

    +
    +

    Tutorial 6 - Resources

    Resource classes are just View classes that don't have any handler methods bound to them. The actions on a resource are defined,

    This allows us to:

      @@ -173,20 +174,17 @@ urlpatterns = router.urlpatterns
    • Follow me on Twitter and say hi.

    Now go build some awesome things.

    -
    -
    -
    +
    +
    +
    +
    -
    +
    - +