aboutsummaryrefslogtreecommitdiffstats
path: root/tutorial/quickstart.html
diff options
context:
space:
mode:
authorTom Christie2013-11-17 18:26:41 +0000
committerTom Christie2013-11-17 18:26:41 +0000
commitd5edf20cee559050b70dd095bf243287bf2c2248 (patch)
treee381b83d56b74357ba42b3bc91ef437cbbf62768 /tutorial/quickstart.html
downloaddjango-rest-framework-d5edf20cee559050b70dd095bf243287bf2c2248.tar.bz2
gh-pages hosted docs
Diffstat (limited to 'tutorial/quickstart.html')
-rw-r--r--tutorial/quickstart.html385
1 files changed, 385 insertions, 0 deletions
diff --git a/tutorial/quickstart.html b/tutorial/quickstart.html
new file mode 100644
index 00000000..079177ce
--- /dev/null
+++ b/tutorial/quickstart.html
@@ -0,0 +1,385 @@
+<!DOCTYPE html>
+<html lang="en">
+<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <meta charset="utf-8">
+ <title>Django REST framework - Quickstart</title>
+ <link href="http://django-rest-framework.org/img/favicon.ico" rel="icon" type="image/x-icon">
+ <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 -->
+ <link href="http://django-rest-framework.org/css/prettify.css" rel="stylesheet">
+ <link href="http://django-rest-framework.org/css/bootstrap.css" rel="stylesheet">
+ <link href="http://django-rest-framework.org/css/bootstrap-responsive.css" rel="stylesheet">
+ <link href="http://django-rest-framework.org/css/default.css" rel="stylesheet">
+
+ <!-- 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>
+ </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>
+ <a class="repo-link btn btn-inverse btn-small " href="../tutorial/1-serialization.html">Next <i class="icon-arrow-right icon-white"></i></a>
+ <a class="repo-link btn btn-inverse btn-small " href="../index.html"><i class="icon-arrow-left icon-white"></i> Previous</a>
+ <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>
+ <a class="brand" href="http://django-rest-framework.org">Django REST framework</a>
+ <div class="nav-collapse collapse">
+ <ul class="nav">
+ <li><a href="http://django-rest-framework.org">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://django-rest-framework.org/tutorial/quickstart.html">Quickstart</a></li>
+ <li><a href="http://django-rest-framework.org/tutorial/1-serialization.html">1 - Serialization</a></li>
+ <li><a href="http://django-rest-framework.org/tutorial/2-requests-and-responses.html">2 - Requests and responses</a></li>
+ <li><a href="http://django-rest-framework.org/tutorial/3-class-based-views.html">3 - Class based views</a></li>
+ <li><a href="http://django-rest-framework.org/tutorial/4-authentication-and-permissions.html">4 - Authentication and permissions</a></li>
+ <li><a href="http://django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis.html">5 - Relationships and hyperlinked APIs</a></li>
+ <li><a href="http://django-rest-framework.org/tutorial/6-viewsets-and-routers.html">6 - Viewsets and routers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://django-rest-framework.org/api-guide/requests.html">Requests</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/responses.html">Responses</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/views.html">Views</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/generic-views.html">Generic views</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/viewsets.html">Viewsets</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/routers.html">Routers</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/parsers.html">Parsers</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/renderers.html">Renderers</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/serializers.html">Serializers</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/fields.html">Serializer fields</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/relations.html">Serializer relations</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/authentication.html">Authentication</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/permissions.html">Permissions</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/throttling.html">Throttling</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/filtering.html">Filtering</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/pagination.html">Pagination</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/content-negotiation.html">Content negotiation</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/format-suffixes.html">Format suffixes</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/reverse.html">Returning URLs</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/exceptions.html">Exceptions</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/status-codes.html">Status codes</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/testing.html">Testing</a></li>
+ <li><a href="http://django-rest-framework.org/api-guide/settings.html">Settings</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://django-rest-framework.org/topics/documenting-your-api.html">Documenting your API</a></li>
+ <li><a href="http://django-rest-framework.org/topics/ajax-csrf-cors.html">AJAX, CSRF & CORS</a></li>
+ <li><a href="http://django-rest-framework.org/topics/browser-enhancements.html">Browser enhancements</a></li>
+ <li><a href="http://django-rest-framework.org/topics/browsable-api.html">The Browsable API</a></li>
+ <li><a href="http://django-rest-framework.org/topics/rest-hypermedia-hateoas.html">REST, Hypermedia & HATEOAS</a></li>
+ <li><a href="http://django-rest-framework.org/topics/rest-framework-2-announcement.html">2.0 Announcement</a></li>
+ <li><a href="http://django-rest-framework.org/topics/2.2-announcement.html">2.2 Announcement</a></li>
+ <li><a href="http://django-rest-framework.org/topics/2.3-announcement.html">2.3 Announcement</a></li>
+ <li><a href="http://django-rest-framework.org/topics/release-notes.html">Release Notes</a></li>
+ <li><a href="http://django-rest-framework.org/topics/credits.html">Credits</a></li>
+ </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">&times;</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">&laquo; previous</a>
+ <a class="btn btn-mini btn-primary" style="float: right; margin-right: 8px; width: 60px;">next &raquo;</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>
+
+ <div>
+ <hr>
+
+<p><strong>The team behind REST framework are launching a new API service.</strong></p>
+
+<p>If you want to be first in line when we start issuing invitations, please sign up here:</p>
+
+<!-- Begin MailChimp Signup Form -->
+<link href="//cdn-images.mailchimp.com/embedcode/slim-081711.css" rel="stylesheet" type="text/css">
+<style type="text/css">
+ #mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
+ /* Add your own MailChimp form style overrides in your site stylesheet or in this style block.
+ We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
+</style>
+<div id="mc_embed_signup" style="background: rgb(245, 245, 245)">
+<form action="http://dabapps.us1.list-manage1.com/subscribe/post?u=cf73a9994eb5b8d8d461b5dfb&amp;id=cb6af8e8bd" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
+<!-- <label for="mce-EMAIL">Keep me posted!</label>
+ --> <input style="width: 90%" type="email" value="" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" required>
+ <div class="clear"><input class="btn btn-success" type="submit" value="Yes, keep me posted!" name="subscribe" id="mc-embedded-subscribe" class="button"></div>
+</form>
+</div>
+</style></div>
+ </ul>
+
+
+<!--End mc_embed_signup-->
+ </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>
+<pre class="prettyprint lang-py"><code># Set up a new project
+django-admin.py startproject tutorial
+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
+
+# Create a new app
+python manage.py startapp quickstart
+</code></pre>
+<p>Next you'll need to get a database set up and synced. If you just want to use SQLite for now, then you'll want to edit your <code>tutorial/settings.py</code> module to include something like this:</p>
+<pre class="prettyprint lang-py"><code>DATABASES = {
+ 'default': {
+ 'ENGINE': 'django.db.backends.sqlite3',
+ 'NAME': 'database.sql',
+ 'USER': '',
+ 'PASSWORD': '',
+ 'HOST': '',
+ 'PORT': ''
+ }
+}
+</code></pre>
+<p>The run <code>syncdb</code> like so:</p>
+<pre class="prettyprint lang-py"><code>python manage.py syncdb
+</code></pre>
+<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>
+<p>First up we're going to define some serializers in <code>quickstart/serializers.py</code> that we'll use for our data representations.</p>
+<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>
+<p>Right, we'd better write some views then. Open <code>quickstart/views.py</code> and get typing.</p>
+<pre class="prettyprint lang-py"><code>from django.contrib.auth.models import User, Group
+from rest_framework import viewsets
+from quickstart.serializers import UserSerializer, GroupSerializer
+
+
+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>
+<h2 id="urls">URLs</h2>
+<p>Okay, now let's wire up the API URLs. On to <code>tutorial/urls.py</code>...</p>
+<pre class="prettyprint lang-py"><code>from django.conf.urls import patterns, url, include
+from rest_framework import routers
+from quickstart import views
+
+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.
+urlpatterns = patterns('',
+ url(r'^', include(router.urls)),
+ url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
+)
+</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>
+<pre class="prettyprint lang-py"><code>bash: curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
+{
+ "count": 2,
+ "next": null,
+ "previous": null,
+ "results": [
+ {
+ "email": "admin@example.com",
+ "groups": [],
+ "url": "http://127.0.0.1:8000/users/1/",
+ "username": "admin"
+ },
+ {
+ "email": "tom@example.com",
+ "groups": [ ],
+ "url": "http://127.0.0.1:8000/users/2/",
+ "username": "tom"
+ }
+ ]
+}
+</code></pre>
+<p>Or directly through the browser...</p>
+<p><img alt="Quick start image" src="../img/quickstart.png" /></p>
+<p>Great, that was easy!</p>
+<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.html">the tutorial</a>, or start browsing the <a href="../#api-guide">API guide</a>.</p>
+ </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 -->
+ <script src="http://django-rest-framework.org/js/jquery-1.8.1-min.js"></script>
+ <script src="http://django-rest-framework.org/js/prettify-1.0.js"></script>
+ <script src="http://django-rest-framework.org/js/bootstrap-2.1.1-min.js"></script>
+ <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>
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-01 13:28:35 +0000