Authentication is the mechanism of associating an incoming request with a set of identifying credentials, such as the user the request came from, or the token that it was signed with. The permission and throttling policies can then use those credentials to determine if the request should be permitted.
+Authentication is the mechanism of associating an incoming request with a set of identifying credentials, such as the user the request came from, or the token that it was signed with. The permission and throttling policies can then use those credentials to determine if the request should be permitted.
REST framework provides a number of authentication policies out of the box, and also allows you to implement custom policies.
Authentication will run the first time either the request.user or request.auth properties are accessed, and determines how those properties are initialized.
The 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, and is highly recommended reading.
The API guide is your complete reference manual to all the functionality provided by REST framework.
General guides to using REST framework.
If you want to work on REST framework itself, clone the repository, then...
diff --git a/topics/contributing.html b/topics/contributing.html index 69ea6a80c..7fa997865 100644 --- a/topics/contributing.html +++ b/topics/contributing.html @@ -88,7 +88,6 @@ margin-top: 5px;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.
+We'll see how we can start to improve things in part 2 of the tutorial.
We don't necessarily need to add these extra url patterns in, but it gives us a simple, clean way of refering to a specific format.
Go ahead and test the API from the command line, as we did in tutorial part 1. Everything is working pretty similarly, although we've got some nicer error handling if we send invalid requests.
+Go ahead and test the API from the command line, as we did in tutorial part 1. Everything is working pretty similarly, although we've got some nicer error handling if we send invalid requests.
TODO: Describe using accept headers, content-type headers, and format suffixed URLs
Now go and open the API in a web browser, by visiting http://127.0.0.1:8000/.
TODO: Describe browseable API awesomeness
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.
+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 b48dcade6..5782a36f1 100644 --- a/tutorial/3-class-based-views.html +++ b/tutorial/3-class-based-views.html @@ -88,7 +88,6 @@ margin-top: 5px;Wow, that's pretty concise. We've got a huge amount for free, and our code looks like good, clean, idomatic 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.
+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 022237d11..61bcdd2a4 100644 --- a/tutorial/4-authentication-permissions-and-throttling.html +++ b/tutorial/4-authentication-permissions-and-throttling.html @@ -88,7 +88,6 @@ margin-top: 5px;