2013-11-17 22:26:41 +04:00
<!DOCTYPE html>
< html lang = "en" >
< head > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
2013-12-23 16:37:56 +04:00
< title > Quickstart - Django REST framework< / title >
2014-08-02 18:29:15 +04:00
< link href = "http://www.django-rest-framework.org/img/favicon.ico" rel = "icon" type = "image/x-icon" >
< link rel = "canonical" href = "http://www.django-rest-framework.org/tutorial/quickstart" / >
2013-11-17 22:26:41 +04:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, Quickstart" >
< meta name = "author" content = "Tom Christie" >
<!-- Le styles -->
2014-08-02 18:29:15 +04:00
< link href = "http://www.django-rest-framework.org/css/prettify.css" rel = "stylesheet" >
< link href = "http://www.django-rest-framework.org/css/bootstrap.css" rel = "stylesheet" >
< link href = "http://www.django-rest-framework.org/css/bootstrap-responsive.css" rel = "stylesheet" >
< link href = "http://www.django-rest-framework.org/css/default.css" rel = "stylesheet" >
2013-11-17 22:26:41 +04:00
<!-- Le HTML5 shim, for IE6 - 8 support of HTML5 elements -->
<!-- [if lt IE 9]>
< script src = "http://html5shim.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< script type = "text/javascript" >
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18852272-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
< / script >
2014-07-15 18:02:49 +04:00
< style >
span.fusion-wrap a {
display: block;
margin-top: 10px;
color: black;
}
a.fusion-poweredby {
display: block;
margin-top: 10px;
}
@media (max-width: 767px) {
div.promo {display: none;}
}
< / style >
2013-11-17 22:26:41 +04:00
< / head >
< body onload = "prettyPrint()" class = "quickstart-page" >
< div class = "wrapper" >
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/tomchristie/django-rest-framework/tree/master" > GitHub< / a >
2014-08-02 18:29:15 +04:00
< a class = "repo-link btn btn-inverse btn-small " href = "../tutorial/1-serialization" > Next < i class = "icon-arrow-right icon-white" > < / i > < / a >
< a class = "repo-link btn btn-inverse btn-small " href = "/" > < i class = "icon-arrow-left icon-white" > < / i > Previous< / a >
2013-11-17 22:26:41 +04:00
< a class = "repo-link btn btn-inverse btn-small" href = "#searchModal" data-toggle = "modal" > < i class = "icon-search icon-white" > < / i > Search< / a >
< a class = "btn btn-navbar" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / a >
2014-08-02 18:29:15 +04:00
< a class = "brand" href = "http://www.django-rest-framework.org" > Django REST framework< / a >
2013-11-17 22:26:41 +04:00
< div class = "nav-collapse collapse" >
< ul class = "nav" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org" > Home< / a > < / li >
2013-11-17 22:26:41 +04:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/tutorial/quickstart" > Quickstart< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/1-serialization" > 1 - Serialization< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/2-requests-and-responses" > 2 - Requests and responses< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/3-class-based-views" > 3 - Class based views< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/4-authentication-and-permissions" > 4 - Authentication and permissions< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis" > 5 - Relationships and hyperlinked APIs< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers" > 6 - Viewsets and routers< / a > < / li >
2013-11-17 22:26:41 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/api-guide/requests" > Requests< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/responses" > Responses< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/views" > Views< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/generic-views" > Generic views< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/viewsets" > Viewsets< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/routers" > Routers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/parsers" > Parsers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/renderers" > Renderers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/serializers" > Serializers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/fields" > Serializer fields< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/relations" > Serializer relations< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/authentication" > Authentication< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/permissions" > Permissions< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/throttling" > Throttling< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/filtering" > Filtering< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/pagination" > Pagination< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/content-negotiation" > Content negotiation< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/format-suffixes" > Format suffixes< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/reverse" > Returning URLs< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/exceptions" > Exceptions< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/status-codes" > Status codes< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/testing" > Testing< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/settings" > Settings< / a > < / li >
2013-11-17 22:26:41 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/documenting-your-api" > Documenting your API< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/ajax-csrf-cors" > AJAX, CSRF & CORS< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/browser-enhancements" > Browser enhancements< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/browsable-api" > The Browsable API< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/rest-hypermedia-hateoas" > REST, Hypermedia & HATEOAS< / a > < / li >
2014-09-17 17:12:41 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/third-party-resources" > Third Party Resources< / a > < / li >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/contributing" > Contributing to REST framework< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/rest-framework-2-announcement" > 2.0 Announcement< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/2.2-announcement" > 2.2 Announcement< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/2.3-announcement" > 2.3 Announcement< / a > < / li >
2014-08-29 13:11:44 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/2.4-announcement" > 2.4 Announcement< / a > < / li >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/kickstarter-announcement" > Kickstarter Announcement< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/release-notes" > Release Notes< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/credits" > Credits< / a > < / li >
2013-11-17 22:26:41 +04:00
< / ul >
< / li >
< / ul >
< ul class = "nav pull-right" >
<!-- TODO
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Version: 2.0.0 < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li > < a href = "#" > Trunk< / a > < / li >
< li > < a href = "#" > 2.0.0< / a > < / li >
< / ul >
< / li >
-->
< / ul >
< / div > <!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "body-content" >
< div class = "container-fluid" >
<!-- Search Modal -->
< div id = "searchModal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria-labelledby = "myModalLabel" aria-hidden = "true" >
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × < / button >
< h3 id = "myModalLabel" > Documentation search< / h3 >
< / div >
< div class = "modal-body" >
<!-- Custom google search -->
< script >
(function() {
var cx = '015016005043623903336:rxraeohqk6w';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
'//www.google.com/cse/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
< / script >
< gcse:search > < / gcse:search >
< / div >
< div class = "modal-footer" >
< button class = "btn" data-dismiss = "modal" aria-hidden = "true" > Close< / button >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span3" >
<!-- TODO
< p style = "margin-top: -12px" >
< a class = "btn btn-mini btn-primary" style = "width: 60px" > « previous< / a >
< a class = "btn btn-mini btn-primary" style = "float: right; margin-right: 8px; width: 60px;" > next » < / a >
< / p >
-->
< div id = "table-of-contents" >
< ul class = "nav nav-list side-nav well sidebar-nav-fixed" >
< li class = "main" > < a href = "#quickstart" > Quickstart< / a > < / li >
< li > < a href = "#project-setup" > Project setup< / a > < / li >
< li > < a href = "#serializers" > Serializers< / a > < / li >
< li > < a href = "#views" > Views< / a > < / li >
< li > < a href = "#urls" > URLs< / a > < / li >
< li > < a href = "#settings" > Settings< / a > < / li >
< li > < a href = "#testing-our-api" > Testing our API< / a > < / li >
2014-07-15 18:02:49 +04:00
< div class = "promo" >
< / div >
2014-01-03 17:26:35 +04:00
< / ul >
2013-11-17 22:26:41 +04:00
< / div >
< / div >
< div id = "main-content" class = "span9" >
< h1 id = "quickstart" > Quickstart< / h1 >
< p > We're going to create a simple API to allow admin users to view and edit the users and groups in the system.< / p >
< h2 id = "project-setup" > Project setup< / h2 >
< p > Create a new Django project named < code > tutorial< / code > , then start a new app called < code > quickstart< / code > .< / p >
2014-08-20 14:09:41 +04:00
< pre class = "prettyprint lang-py" > < code > # Create the project directory
mkdir tutorial
2013-11-17 22:26:41 +04:00
cd tutorial
# Create a virtualenv to isolate our package dependencies locally
virtualenv env
source env/bin/activate # On Windows use `env\Scripts\activate`
# Install Django and Django REST framework into the virtualenv
pip install django
pip install djangorestframework
2014-08-29 13:11:44 +04:00
# Set up a new project with a single application
django-admin.py startproject tutorial .
cd tutorial
django-admin.py startapp quickstart
cd ..
2013-11-17 22:26:41 +04:00
< / code > < / pre >
2014-08-29 13:11:44 +04:00
< p > Now sync your database for the first time:< / p >
2013-11-17 22:26:41 +04:00
< pre class = "prettyprint lang-py" > < code > python manage.py syncdb
< / code > < / pre >
2014-08-29 13:11:44 +04:00
< p > Make sure to create an initial user named < code > admin< / code > with a password of < code > password< / code > . We'll authenticate as that user later in our example.< / p >
2013-11-17 22:26:41 +04:00
< p > Once you've set up a database and got everything synced and ready to go, open up the app's directory and we'll get coding...< / p >
< h2 id = "serializers" > Serializers< / h2 >
2014-08-29 13:11:44 +04:00
< p > First up we're going to define some serializers. Let's create a new module named < code > tutorial/quickstart/serializers.py< / code > that we'll use for our data representations.< / p >
2013-11-17 22:26:41 +04:00
< pre class = "prettyprint lang-py" > < code > from django.contrib.auth.models import User, Group
from rest_framework import serializers
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ('url', 'username', 'email', 'groups')
class GroupSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = Group
fields = ('url', 'name')
< / code > < / pre >
< p > Notice that we're using hyperlinked relations in this case, with < code > HyperlinkedModelSerializer< / code > . You can also use primary key and various other relationships, but hyperlinking is good RESTful design.< / p >
< h2 id = "views" > Views< / h2 >
2014-08-29 13:11:44 +04:00
< p > Right, we'd better write some views then. Open < code > tutorial/quickstart/views.py< / code > and get typing.< / p >
2013-11-17 22:26:41 +04:00
< pre class = "prettyprint lang-py" > < code > from django.contrib.auth.models import User, Group
from rest_framework import viewsets
2014-08-29 13:11:44 +04:00
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
2013-11-17 22:26:41 +04:00
class UserViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows users to be viewed or edited.
"""
queryset = User.objects.all()
serializer_class = UserSerializer
class GroupViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows groups to be viewed or edited.
"""
queryset = Group.objects.all()
serializer_class = GroupSerializer
< / code > < / pre >
< p > Rather than write multiple views we're grouping together all the common behavior into classes called < code > ViewSets< / code > .< / p >
< p > We can easily break these down into individual views if we need to, but using viewsets keeps the view logic nicely organized as well as being very concise.< / p >
2013-12-15 00:44:09 +04:00
< p > Notice that our viewset classes here are a little different from those in the < a href = "../#example" > frontpage example< / a > , as they include < code > queryset< / code > and < code > serializer_class< / code > attributes, instead of a < code > model< / code > attribute.< / p >
< p > For trivial cases you can simply set a < code > model< / code > attribute on the < code > ViewSet< / code > class and the serializer and queryset will be automatically generated for you. Setting the < code > queryset< / code > and/or < code > serializer_class< / code > attributes gives you more explicit control of the API behaviour, and is the recommended style for most applications.< / p >
2013-11-17 22:26:41 +04:00
< h2 id = "urls" > URLs< / h2 >
< p > Okay, now let's wire up the API URLs. On to < code > tutorial/urls.py< / code > ...< / p >
2014-08-29 13:11:44 +04:00
< pre class = "prettyprint lang-py" > < code > from django.conf.urls import url, include
2013-11-17 22:26:41 +04:00
from rest_framework import routers
2014-08-29 13:11:44 +04:00
from tutorial.quickstart import views
2013-11-17 22:26:41 +04:00
router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)
# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browseable API.
2014-08-29 13:11:44 +04:00
urlpatterns = [
2013-11-17 22:26:41 +04:00
url(r'^', include(router.urls)),
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
2014-08-29 13:11:44 +04:00
]
2013-11-17 22:26:41 +04:00
< / code > < / pre >
< p > Because we're using viewsets instead of views, we can automatically generate the URL conf for our API, by simply registering the viewsets with a router class.< / p >
< p > Again, if we need more control over the API URLs we can simply drop down to using regular class based views, and writing the URL conf explicitly.< / p >
< p > Finally, we're including default login and logout views for use with the browsable API. That's optional, but useful if your API requires authentication and you want to use the browsable API.< / p >
< h2 id = "settings" > Settings< / h2 >
< p > We'd also like to set a few global settings. We'd like to turn on pagination, and we want our API to only be accessible to admin users. The settings module will be in < code > tutorial/settings.py< / code > < / p >
< pre class = "prettyprint lang-py" > < code > INSTALLED_APPS = (
...
'rest_framework',
)
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAdminUser',),
'PAGINATE_BY': 10
}
< / code > < / pre >
< p > Okay, we're done.< / p >
< hr / >
< h2 id = "testing-our-api" > Testing our API< / h2 >
< p > We're now ready to test the API we've built. Let's fire up the server from the command line.< / p >
< pre class = "prettyprint lang-py" > < code > python ./manage.py runserver
< / code > < / pre >
< p > We can now access our API, both from the command-line, using tools like < code > curl< / code > ...< / p >
2014-08-18 14:10:41 +04:00
< pre class = "prettyprint lang-py" > < code > bash: curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
2013-11-17 22:26:41 +04:00
{
2014-08-18 14:10:41 +04:00
"count": 2,
"next": null,
"previous": null,
2013-11-17 22:26:41 +04:00
"results": [
{
2014-08-18 14:10:41 +04:00
"email": "admin@example.com",
"groups": [],
"url": "http://127.0.0.1:8000/users/1/",
2013-11-17 22:26:41 +04:00
"username": "admin"
2014-08-18 14:10:41 +04:00
},
2013-11-17 22:26:41 +04:00
{
2014-08-18 14:10:41 +04:00
"email": "tom@example.com",
"groups": [ ],
"url": "http://127.0.0.1:8000/users/2/",
2013-11-17 22:26:41 +04:00
"username": "tom"
}
]
}
< / code > < / pre >
< p > Or directly through the browser...< / p >
< p > < img alt = "Quick start image" src = "../img/quickstart.png" / > < / p >
2014-08-29 13:11:44 +04:00
< p > If you're working through the browser, make sure to login using the control in the top right corner.< / p >
2013-11-17 22:26:41 +04:00
< p > Great, that was easy!< / p >
2014-08-02 18:29:15 +04:00
< p > If you want to get a more in depth understanding of how REST framework fits together head on over to < a href = "1-serialization" > the tutorial< / a > , or start browsing the < a href = "../#api-guide" > API guide< / a > .< / p >
2013-11-17 22:26:41 +04:00
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
< / div > <!-- /.body content -->
< div id = "push" > < / div >
< / div > <!-- /.wrapper -->
< footer class = "span12" >
< p > Sponsored by < a href = "http://dabapps.com/" > DabApps< / a > .< / a > < / p >
< / footer >
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
2014-08-02 18:29:15 +04:00
< script src = "http://www.django-rest-framework.org/js/jquery-1.8.1-min.js" > < / script >
< script src = "http://www.django-rest-framework.org/js/prettify-1.0.js" > < / script >
< script src = "http://www.django-rest-framework.org/js/bootstrap-2.1.1-min.js" > < / script >
2014-07-15 18:02:49 +04:00
2013-11-17 22:26:41 +04:00
< script >
//$('.side-nav').scrollspy()
var shiftWindow = function() { scrollBy(0, -50) };
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
$('.dropdown-menu').on('click touchstart', function(event) {
event.stopPropagation();
});
// Dynamically force sidenav to no higher than browser window
$('.side-nav').css('max-height', window.innerHeight - 130);
$(function(){
$(window).resize(function(){
$('.side-nav').css('max-height', window.innerHeight - 130);
});
});
< / script >
< / body > < / html >
