2014-11-25 19:04:38 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
2015-05-15 11:19:49 +03:00
< title > Quickstart - Django REST framework< / title >
2014-11-25 19:04:38 +03:00
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
2018-10-11 16:48:33 +03:00
< link rel = "canonical" href = "https://www.django-rest-framework.org/tutorial/quickstart/" / >
2014-11-25 19:04:38 +03: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 -->
< link href = "../../css/prettify.css" rel = "stylesheet" >
< link href = "../../css/bootstrap.css" rel = "stylesheet" >
< link href = "../../css/bootstrap-responsive.css" rel = "stylesheet" >
< link href = "../../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 >
< style >
2016-05-26 13:48:39 +03:00
#sidebarInclude img {
margin-bottom: 10px;
}
#sidebarInclude a.promo {
2014-11-25 19:04:38 +03:00
color: black;
2016-05-26 13:48:39 +03:00
}
2014-11-25 19:04:38 +03:00
@media (max-width: 767px) {
div.promo {
display: none;
}
}
< / style >
< / head >
< body onload = "prettyPrint()" class = "-page" >
< div class = "wrapper" >
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
2017-05-12 19:15:00 +03:00
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/encode/django-rest-framework/tree/master" > GitHub< / a >
2019-07-15 14:38:39 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "tutorial/1-serialization/" >
2014-11-25 19:04:38 +03:00
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
2019-07-15 14:38:39 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "" >
2014-11-25 19:04:38 +03:00
< i class = "icon-arrow-left icon-white" > < / i > Previous
< / a >
2015-06-04 17:37:22 +03:00
< a id = "search_modal_show" class = "repo-link btn btn-inverse btn-small" href = "#mkdocs_search_modal" data-toggle = "modal" data-target = "#mkdocs_search_modal" > < i class = "icon-search icon-white" > < / i > Search< / a >
2014-11-25 19:04:38 +03:00
< 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 >
2018-10-11 16:48:33 +03:00
< a class = "brand" href = "https://www.django-rest-framework.org/" > Django REST framework< / a >
2014-11-25 19:04:38 +03:00
< div class = "nav-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
2015-06-04 17:37:22 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "" > Home< / a >
2015-06-04 17:37:22 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li class = "dropdown active" >
2014-11-25 19:31:00 +03:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
2014-11-25 19:04:38 +03:00
< ul class = "dropdown-menu" >
< li class = "active" >
2019-07-15 14:38:39 +03:00
< a href = "tutorial/quickstart/" > Quickstart< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "tutorial/1-serialization/" > 1 - Serialization< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "tutorial/2-requests-and-responses/" > 2 - Requests and responses< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "tutorial/3-class-based-views/" > 3 - Class based views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "tutorial/4-authentication-and-permissions/" > 4 - Authentication and permissions< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "tutorial/5-relationships-and-hyperlinked-apis/" > 5 - Relationships and hyperlinked APIs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "tutorial/6-viewsets-and-routers/" > 6 - Viewsets and routers< / a >
2016-07-14 15:05:57 +03:00
< / li >
2014-11-25 19:04:38 +03: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" >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/requests/" > Requests< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/responses/" > Responses< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/views/" > Views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/generic-views/" > Generic views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/viewsets/" > Viewsets< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/routers/" > Routers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/parsers/" > Parsers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/renderers/" > Renderers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/serializers/" > Serializers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/fields/" > Serializer fields< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/relations/" > Serializer relations< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-01 15:20:07 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/validators/" > Validators< / a >
2014-12-01 15:20:07 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/authentication/" > Authentication< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/permissions/" > Permissions< / a >
2014-11-25 19:04:38 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/caching/" > Caching< / a >
2018-10-11 16:48:33 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/throttling/" > Throttling< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/filtering/" > Filtering< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/pagination/" > Pagination< / a >
2014-11-25 19:04:38 +03:00
< / li >
2015-03-06 15:05:16 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/versioning/" > Versioning< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/content-negotiation/" > Content negotiation< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-18 18:42:42 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/metadata/" > Metadata< / a >
2014-12-18 18:42:42 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/schemas/" > Schemas< / a >
2016-07-07 11:41:32 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/format-suffixes/" > Format suffixes< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/reverse/" > Returning URLs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/exceptions/" > Exceptions< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/status-codes/" > Status codes< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/testing/" > Testing< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "api-guide/settings/" > Settings< / a >
2014-11-25 19:04:38 +03:00
< / 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 >
2019-07-15 14:38:39 +03:00
< a href = "topics/documenting-your-api/" > Documenting your API< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "topics/api-clients/" > API Clients< / a >
2016-07-07 11:41:32 +03:00
< / li >
2015-03-06 15:05:16 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "topics/internationalization/" > Internationalization< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "topics/ajax-csrf-cors/" > AJAX, CSRF & CORS< / a >
2014-11-25 19:04:38 +03:00
< / li >
2015-10-28 14:35:39 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "topics/html-and-forms/" > HTML & Forms< / a >
2015-10-28 14:35:39 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "topics/browser-enhancements/" > Browser Enhancements< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "topics/browsable-api/" > The Browsable API< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "topics/rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
2014-11-25 19:04:38 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/tutorials-and-resources/" > Tutorials and Resources< / a >
2017-02-25 22:59:44 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/third-party-packages/" > Third Party Packages< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/contributing/" > Contributing to REST framework< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-18 16:49:50 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/project-management/" > Project management< / a >
2014-12-18 16:49:50 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/release-notes/" > Release Notes< / a >
2017-03-09 17:59:14 +03:00
< / li >
2018-10-18 13:50:44 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.10-announcement/" > 3.10 Announcement< / a >
2018-10-18 13:50:44 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.9-announcement/" > 3.9 Announcement< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-01 15:20:07 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.8-announcement/" > 3.8 Announcement< / a >
2014-12-01 15:20:07 +03:00
< / li >
2015-08-06 16:31:52 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.7-announcement/" > 3.7 Announcement< / a >
2015-08-06 16:31:52 +03:00
< / li >
2015-10-28 14:35:39 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.6-announcement/" > 3.6 Announcement< / a >
2015-10-28 14:35:39 +03:00
< / li >
2016-07-14 15:05:57 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.5-announcement/" > 3.5 Announcement< / a >
2016-07-14 15:05:57 +03:00
< / li >
2016-10-20 18:31:37 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.4-announcement/" > 3.4 Announcement< / a >
2016-10-20 18:31:37 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.3-announcement/" > 3.3 Announcement< / a >
2017-03-09 17:59:14 +03:00
< / li >
2017-10-06 15:06:25 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.2-announcement/" > 3.2 Announcement< / a >
2017-10-06 15:06:25 +03:00
< / li >
2018-04-03 16:54:40 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.1-announcement/" > 3.1 Announcement< / a >
2018-04-03 16:54:40 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/3.0-announcement/" > 3.0 Announcement< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-05-26 13:48:39 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/kickstarter-announcement/" > Kickstarter Announcement< / a >
2016-05-26 13:48:39 +03:00
< / li >
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/mozilla-grant/" > Mozilla Grant< / a >
2016-05-26 13:48:39 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2019-07-15 14:38:39 +03:00
< a href = "community/funding/" > Funding< / a >
< / li >
< li >
< a href = "community/jobs/" > Jobs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< / ul >
< / li >
< / ul >
< / div >
<!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "body-content" >
< div class = "container-fluid" >
<!-- Search Modal -->
2015-06-04 17:37:22 +03:00
< div id = "mkdocs_search_modal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria-labelledby = "myModalLabel" aria-hidden = "true" >
2014-11-25 19:04:38 +03:00
< 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" >
2015-08-06 16:31:52 +03:00
< form role = "form" autocomplete = "off" >
2015-06-04 17:37:22 +03:00
< div class = "form-group" >
< input type = "text" name = "q" class = "form-control" placeholder = "Search..." id = "mkdocs-search-query" >
< / div >
< / form >
< div id = "mkdocs-search-results" > < / div >
2014-11-25 19:04:38 +03:00
< / 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" >
< 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 >
2018-10-11 16:48:33 +03:00
< li >
< a href = "#pagination" > Pagination< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
< a href = "#settings" > Settings< / a >
< / li >
< li >
< a href = "#testing-our-api" > Testing our API< / a >
< / li >
2016-05-26 13:48:39 +03:00
< div class = "promo" >
< hr / >
< div id = "sidebarInclude" >
< / div >
2014-11-25 19:04:38 +03:00
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
2015-06-04 17:37:22 +03:00
2015-11-04 17:59:23 +03:00
< h1 id = "quickstart" > < a class = "toclink" href = "#quickstart" > Quickstart< / a > < / h1 >
2014-11-25 19:04:38 +03:00
< 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 >
2015-11-04 17:59:23 +03:00
< h2 id = "project-setup" > < a class = "toclink" href = "#project-setup" > Project setup< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > Create a new Django project named < code > tutorial< / code > , then start a new app called < code > quickstart< / code > .< / p >
< pre > < code > # Create the project directory
mkdir tutorial
cd tutorial
2019-06-04 14:04:28 +03:00
# Create a virtual environment to isolate our package dependencies locally
python3 -m venv env
2014-11-25 19:04:38 +03:00
source env/bin/activate # On Windows use `env\Scripts\activate`
2019-06-04 14:04:28 +03:00
# Install Django and Django REST framework into the virtual environment
2014-11-25 19:04:38 +03:00
pip install django
pip install djangorestframework
# Set up a new project with a single application
2018-10-11 16:48:33 +03:00
django-admin startproject tutorial . # Note the trailing '.' character
2014-11-25 19:04:38 +03:00
cd tutorial
2018-10-11 16:48:33 +03:00
django-admin startapp quickstart
2014-12-08 19:38:49 +03:00
cd ..
2014-11-25 19:04:38 +03:00
< / code > < / pre >
2017-10-06 15:06:25 +03:00
< p > The project layout should look like:< / p >
< pre > < code > $ pwd
< some path> /tutorial
$ find .
.
./manage.py
./tutorial
./tutorial/__init__.py
./tutorial/quickstart
./tutorial/quickstart/__init__.py
./tutorial/quickstart/admin.py
./tutorial/quickstart/apps.py
./tutorial/quickstart/migrations
./tutorial/quickstart/migrations/__init__.py
./tutorial/quickstart/models.py
./tutorial/quickstart/tests.py
./tutorial/quickstart/views.py
./tutorial/settings.py
./tutorial/urls.py
./tutorial/wsgi.py
< / code > < / pre >
2019-01-16 16:29:55 +03:00
< p > It may look unusual that the application has been created within the project directory. Using the project's namespace avoids name clashes with external modules (a topic that goes outside the scope of the quickstart).< / p >
2014-11-25 19:04:38 +03:00
< p > Now sync your database for the first time:< / p >
< pre > < code > python manage.py migrate
< / code > < / pre >
2016-02-05 18:25:03 +03:00
< p > We'll also create an initial user named < code > admin< / code > with a password of < code > password123< / code > . We'll authenticate as that user later in our example.< / p >
2017-12-20 17:34:31 +03:00
< pre > < code > python manage.py createsuperuser --email admin@example.com --username admin
2014-11-25 19:04:38 +03:00
< / code > < / pre >
2018-10-11 16:48:33 +03:00
< p > Once you've set up a database and the initial user is created and ready to go, open up the app's directory and we'll get coding...< / p >
2015-11-04 17:59:23 +03:00
< h2 id = "serializers" > < a class = "toclink" href = "#serializers" > Serializers< / a > < / h2 >
2014-11-25 19:04:38 +03: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 >
< pre > < code > from django.contrib.auth.models import User, Group
from rest_framework import serializers
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
2019-07-15 14:38:39 +03:00
fields = ['url', 'username', 'email', 'groups']
2014-11-25 19:04:38 +03:00
class GroupSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = Group
2019-07-15 14:38:39 +03:00
fields = ['url', 'name']
2014-11-25 19:04:38 +03:00
< / code > < / pre >
2019-01-16 16:29:55 +03:00
< 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 >
2015-11-04 17:59:23 +03:00
< h2 id = "views" > < a class = "toclink" href = "#views" > Views< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > Right, we'd better write some views then. Open < code > tutorial/quickstart/views.py< / code > and get typing.< / p >
< pre > < code > from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
class UserViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows users to be viewed or edited.
"""
2015-08-06 16:31:52 +03:00
queryset = User.objects.all().order_by('-date_joined')
2014-11-25 19:04:38 +03:00
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 >
2015-11-04 17:59:23 +03:00
< h2 id = "urls" > < a class = "toclink" href = "#urls" > URLs< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > Okay, now let's wire up the API URLs. On to < code > tutorial/urls.py< / code > ...< / p >
2019-01-16 16:29:55 +03:00
< pre > < code > from django.urls import include, path
2014-11-25 19:04:38 +03:00
from rest_framework import routers
from tutorial.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.
2014-12-05 12:44:35 +03:00
# Additionally, we include login URLs for the browsable API.
2014-11-25 19:04:38 +03:00
urlpatterns = [
2019-01-16 16:29:55 +03:00
path('', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
2014-11-25 19:04:38 +03: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 >
2016-07-14 15:05:57 +03:00
< 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 >
2014-11-25 19:04:38 +03:00
< 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 >
2018-10-11 16:48:33 +03:00
< h2 id = "pagination" > < a class = "toclink" href = "#pagination" > Pagination< / a > < / h2 >
2019-01-16 16:29:55 +03:00
< p > Pagination allows you to control how many objects per page are returned. To enable it add the following lines to < code > tutorial/settings.py< / code > < / p >
2018-10-11 16:48:33 +03:00
< pre > < code > REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}
< / code > < / pre >
2015-11-04 17:59:23 +03:00
< h2 id = "settings" > < a class = "toclink" href = "#settings" > Settings< / a > < / h2 >
2017-12-20 17:34:31 +03:00
< p > Add < code > 'rest_framework'< / code > to < code > INSTALLED_APPS< / code > . The settings module will be in < code > tutorial/settings.py< / code > < / p >
2019-07-15 14:38:39 +03:00
< pre > < code > INSTALLED_APPS = [
2014-11-25 19:04:38 +03:00
...
'rest_framework',
2019-07-15 14:38:39 +03:00
]
2014-11-25 19:04:38 +03:00
< / code > < / pre >
< p > Okay, we're done.< / p >
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "testing-our-api" > < a class = "toclink" href = "#testing-our-api" > Testing our API< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > We're now ready to test the API we've built. Let's fire up the server from the command line.< / p >
2016-06-24 13:07:42 +03:00
< pre > < code > python manage.py runserver
2014-11-25 19:04:38 +03:00
< / code > < / pre >
< p > We can now access our API, both from the command-line, using tools like < code > curl< / code > ...< / p >
2016-02-05 18:25:03 +03:00
< pre > < code > bash: curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/
2014-11-25 19:04:38 +03:00
{
"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 >
2014-12-08 19:38:49 +03:00
< p > Or using the < a href = "https://github.com/jakubroztocil/httpie#installation" > httpie< / a > , command line tool...< / p >
2016-03-14 10:52:29 +03:00
< pre > < code > bash: http -a admin:password123 http://127.0.0.1:8000/users/
2014-12-08 19:38:49 +03:00
HTTP/1.1 200 OK
...
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"email": "admin@example.com",
"groups": [],
"url": "http://localhost:8000/users/1/",
"username": "paul"
},
{
"email": "tom@example.com",
"groups": [ ],
"url": "http://127.0.0.1:8000/users/2/",
"username": "tom"
}
]
}
< / code > < / pre >
2016-06-24 13:07:42 +03:00
< p > Or directly through the browser, by going to the URL < code > http://127.0.0.1:8000/users/< / code > ...< / p >
2015-06-04 17:37:22 +03:00
< p > < img alt = "Quick start image" src = "../../img/quickstart.png" / > < / p >
2014-11-25 19:04:38 +03:00
< p > If you're working through the browser, make sure to login using the control in the top right corner.< / p >
< p > Great, that was easy!< / p >
2019-07-15 14:38:39 +03: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 >
2015-06-04 17:37:22 +03:00
2015-05-15 11:19:49 +03:00
2015-06-23 14:05:53 +03:00
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
< / div > <!-- /.body content -->
2014-11-25 19:04:38 +03:00
< div id = "push" > < / div >
2015-06-23 14:05:53 +03:00
< / div > <!-- /.wrapper -->
2014-11-25 19:04:38 +03:00
< footer class = "span12" >
2015-10-28 14:35:39 +03:00
< p > Documentation built with < a href = "http://www.mkdocs.org/" > MkDocs< / a > .
2014-11-25 19:04:38 +03:00
< / p >
< / footer >
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
< script src = "../../js/jquery-1.8.1-min.js" > < / script >
< script src = "../../js/prettify-1.0.js" > < / script >
< script src = "../../js/bootstrap-2.1.1-min.js" > < / script >
2019-06-04 14:04:28 +03:00
< script async src = "https://fund.django-rest-framework.org/sidebar_include.js" > < / script >
2015-06-04 17:37:22 +03:00
< script > var base _url = '../..' ; < / script >
< script src = "../../mkdocs/js/require.js" > < / script >
2014-12-11 12:55:10 +03:00
< script src = "../../js/theme.js" > < / script >
2014-11-25 19:04:38 +03:00
< script >
var shiftWindow = function() {
scrollBy(0, -50)
};
2015-06-23 14:05:53 +03:00
2014-11-25 19:04:38 +03:00
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
$('.dropdown-menu').on('click touchstart', function(event) {
event.stopPropagation();
});
2015-06-23 14:05:53 +03:00
// Dynamically force sidenav/dropdown to no higher than browser window
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
2014-11-25 19:04:38 +03:00
$(function() {
$(window).resize(function() {
2015-06-23 14:05:53 +03:00
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
2014-11-25 19:04:38 +03:00
});
});
< / script >
< / body >
< / html >
