@@ -134,7 +134,7 @@ If successfully authenticated, `SessionAuthentication` provides the following cr
...
@@ -134,7 +134,7 @@ If successfully authenticated, `SessionAuthentication` provides the following cr
*`request.user` will be a Django `User` instance.
*`request.user` will be a Django `User` instance.
*`request.auth` will be `None`.
*`request.auth` will be `None`.
If you're using an AJAX style API with SessionAuthentication, you'll need to make sure you include a valid CSRF token for any "unsafe" HTTP method calls, such as `PUT`, `POST` or `DELETE` requests. See the [Django CSRF documentation][csrf-ajax] for more details.
If you're using an AJAX style API with SessionAuthentication, you'll need to make sure you include a valid CSRF token for any "unsafe" HTTP method calls, such as `PUT`, `PATCH`, `POST` or `DELETE` requests. See the [Django CSRF documentation][csrf-ajax] for more details.
@@ -85,7 +85,7 @@ The following methods are called before dispatching to the handler method.
...
@@ -85,7 +85,7 @@ The following methods are called before dispatching to the handler method.
## Dispatch methods
## Dispatch methods
The following methods are called directly by the view's `.dispatch()` method.
The following methods are called directly by the view's `.dispatch()` method.
These perform any actions that need to occur before or after calling the handler methods such as `.get()`, `.post()`, `put()` and `.delete()`.
These perform any actions that need to occur before or after calling the handler methods such as `.get()`, `.post()`, `put()`, `patch()` and `.delete()`.
> — [Alfred North Whitehead][cite], An Introduction to Mathematics (1911)
> — [Alfred North Whitehead][cite], An Introduction to Mathematics (1911)
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`.
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`, `PATCH`and `DELETE`.
## URLs
## URLs
...
@@ -79,6 +79,7 @@ The context that's available to the template:
...
@@ -79,6 +79,7 @@ The context that's available to the template:
*`name` : The name of the resource
*`name` : The name of the resource
*`post_form` : A form instance for use by the POST form (if allowed)
*`post_form` : A form instance for use by the POST form (if allowed)
*`put_form` : A form instance for use by the PUT form (if allowed)
*`put_form` : A form instance for use by the PUT form (if allowed)
*`patch_form` : A form instance for use by the PATCH form (if allowed)
> "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"
> "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, PATCH or DELETE"
>
>
> — [RESTful Web Services][cite], Leonard Richardson & Sam Ruby.
> — [RESTful Web Services][cite], Leonard Richardson & Sam Ruby.
## Browser based PUT, DELETE, etc...
## Browser based PUT, PATCH, DELETE, etc...
REST framework supports browser-based `PUT`, `DELETE` and other methods, by
REST framework supports browser-based `PUT`, `PATCH`, `DELETE` and other methods, by
overloading `POST` requests using a hidden form field.
overloading `POST` requests using a hidden form field.
Note that this is the same strategy as is used in [Ruby on Rails][rails].
Note that this is the same strategy as is used in [Ruby on Rails][rails].
...
@@ -51,7 +51,7 @@ the view.
...
@@ -51,7 +51,7 @@ the view.
This is a more concise than using the `accept` override, but it also gives
This is a more concise than using the `accept` override, but it also gives
you less control. (For example you can't specify any media type parameters)
you less control. (For example you can't specify any media type parameters)
## Doesn't HTML5 support PUT and DELETE forms?
## Doesn't HTML5 support PUT, PATCH and DELETE forms?
Nope. It was at one point intended to support `PUT` and `DELETE` forms, but
Nope. It was at one point intended to support `PUT` and `DELETE` forms, but
was later [dropped from the spec][html5]. There remains
was later [dropped from the spec][html5]. There remains