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 > 6 - Viewsets and routers - Django REST framework< / title >
2014-11-25 19:04:38 +03:00
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
< link rel = "canonical" href = "http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2014-11-25 19:24:47 +03:00
< meta name = "description" content = "Django, API, REST, 6 - Viewsets and routers" >
2014-11-25 19:04:38 +03:00
< 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 >
2016-07-14 15:05:57 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../7-schemas-and-client-libraries/" >
2014-11-25 19:04:38 +03:00
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
2015-06-04 17:37:22 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "../5-relationships-and-hyperlinked-apis/" >
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 >
< a class = "brand" href = "http://www.django-rest-framework.org" > Django REST framework< / a >
< div class = "nav-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
2015-06-04 17:37:22 +03:00
< li >
< a href = "../.." > Home< / a >
< / li >
2014-11-25 19:31:00 +03:00
< li class = "dropdown active" >
< 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 >
2015-06-04 17:37:22 +03:00
< a href = "../quickstart/" > Quickstart< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../1-serialization/" > 1 - Serialization< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../2-requests-and-responses/" > 2 - Requests and responses< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../3-class-based-views/" > 3 - Class based views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../4-authentication-and-permissions/" > 4 - Authentication and permissions< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../5-relationships-and-hyperlinked-apis/" > 5 - Relationships and hyperlinked APIs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li class = "active" >
2015-06-04 17:37:22 +03:00
< a href = "./" > 6 - Viewsets and routers< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-07-14 15:05:57 +03:00
< li >
< a href = "../7-schemas-and-client-libraries/" > 7 - Schemas and client libraries< / a >
< / 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 >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/requests/" > Requests< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/responses/" > Responses< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/views/" > Views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/generic-views/" > Generic views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/viewsets/" > Viewsets< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/routers/" > Routers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/parsers/" > Parsers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/renderers/" > Renderers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/serializers/" > Serializers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/fields/" > Serializer fields< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +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 >
2015-06-04 17:37:22 +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 >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/authentication/" > Authentication< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/permissions/" > Permissions< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/throttling/" > Throttling< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/filtering/" > Filtering< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +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 >
2015-06-04 17:37:22 +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 >
2015-06-04 17:37:22 +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 >
2015-06-04 17:37:22 +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 >
< a href = "../../api-guide/schemas/" > Schemas< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/format-suffixes/" > Format suffixes< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/reverse/" > Returning URLs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/exceptions/" > Exceptions< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/status-codes/" > Status codes< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/testing/" > Testing< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +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 >
2015-06-04 17:37:22 +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 >
< a href = "../../topics/api-clients/" > API Clients< / a >
< / li >
2015-03-06 15:05:16 +03:00
< li >
2015-06-04 17:37:22 +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 >
2015-06-04 17:37:22 +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 >
< a href = "../../topics/html-and-forms/" > HTML & Forms< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/browser-enhancements/" > Browser Enhancements< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/browsable-api/" > The Browsable API< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2017-02-25 22:59:44 +03:00
< a href = "../../topics/third-party-packages/" > Third Party Packages< / a >
< / li >
< li >
< a href = "../../topics/tutorials-and-resources/" > Tutorials and Resources< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/contributing/" > Contributing to REST framework< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/project-management/" > Project management< / a >
2014-12-18 16:49:50 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
< a href = "../../topics/jobs/" > Jobs< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/3.0-announcement/" > 3.0 Announcement< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-01 15:20:07 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/3.1-announcement/" > 3.1 Announcement< / a >
2014-12-01 15:20:07 +03:00
< / li >
2015-08-06 16:31:52 +03:00
< li >
< a href = "../../topics/3.2-announcement/" > 3.2 Announcement< / a >
< / li >
2015-10-28 14:35:39 +03:00
< li >
< a href = "../../topics/3.3-announcement/" > 3.3 Announcement< / a >
< / li >
2016-07-14 15:05:57 +03:00
< li >
< a href = "../../topics/3.4-announcement/" > 3.4 Announcement< / a >
< / li >
2016-10-20 18:31:37 +03:00
< li >
< a href = "../../topics/3.5-announcement/" > 3.5 Announcement< / a >
< / li >
2017-03-09 17:59:14 +03:00
< li >
< a href = "../../topics/3.6-announcement/" > 3.6 Announcement< / a >
< / li >
2017-10-06 15:06:25 +03:00
< li >
< a href = "../../topics/3.7-announcement/" > 3.7 Announcement< / a >
< / li >
2018-04-03 16:54:40 +03:00
< li >
< a href = "../../topics/3.8-announcement/" > 3.8 Announcement< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/kickstarter-announcement/" > Kickstarter Announcement< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-05-26 13:48:39 +03:00
< li >
< a href = "../../topics/mozilla-grant/" > Mozilla Grant< / a >
< / li >
< li >
< a href = "../../topics/funding/" > Funding< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../topics/release-notes/" > Release Notes< / 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" >
2016-06-24 13:07:42 +03:00
< a href = "#tutorial-6-viewsets-routers" > Tutorial 6: ViewSets & Routers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
< a href = "#refactoring-to-use-viewsets" > Refactoring to use ViewSets< / a >
< / li >
< li >
< a href = "#binding-viewsets-to-urls-explicitly" > Binding ViewSets to URLs explicitly< / a >
< / li >
< li >
< a href = "#using-routers" > Using Routers< / a >
< / li >
< li >
< a href = "#trade-offs-between-views-vs-viewsets" > Trade-offs between views vs viewsets< / 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 = "tutorial-6-viewsets-routers" > < a class = "toclink" href = "#tutorial-6-viewsets-routers" > Tutorial 6: ViewSets & Routers< / a > < / h1 >
2014-11-25 19:04:38 +03:00
< p > REST framework includes an abstraction for dealing with < code > ViewSets< / code > , that allows the developer to concentrate on modeling the state and interactions of the API, and leave the URL construction to be handled automatically, based on common conventions.< / p >
< p > < code > ViewSet< / code > classes are almost the same thing as < code > View< / code > classes, except that they provide operations such as < code > read< / code > , or < code > update< / code > , and not method handlers such as < code > get< / code > or < code > put< / code > .< / p >
< p > A < code > ViewSet< / code > class is only bound to a set of method handlers at the last moment, when it is instantiated into a set of views, typically by using a < code > Router< / code > class which handles the complexities of defining the URL conf for you.< / p >
2015-11-04 17:59:23 +03:00
< h2 id = "refactoring-to-use-viewsets" > < a class = "toclink" href = "#refactoring-to-use-viewsets" > Refactoring to use ViewSets< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > Let's take our current set of views, and refactor them into view sets.< / p >
< p > First of all let's refactor our < code > UserList< / code > and < code > UserDetail< / code > views into a single < code > UserViewSet< / code > . We can remove the two views, and replace them with a single class:< / p >
< pre > < code > from rest_framework import viewsets
class UserViewSet(viewsets.ReadOnlyModelViewSet):
"""
This viewset automatically provides `list` and `detail` actions.
"""
queryset = User.objects.all()
serializer_class = UserSerializer
< / code > < / pre >
< p > Here we've used the < code > ReadOnlyModelViewSet< / code > class to automatically provide the default 'read-only' operations. We're still setting the < code > queryset< / code > and < code > serializer_class< / code > attributes exactly as we did when we were using regular views, but we no longer need to provide the same information to two separate classes.< / p >
< p > Next we're going to replace the < code > SnippetList< / code > , < code > SnippetDetail< / code > and < code > SnippetHighlight< / code > view classes. We can remove the three views, and again replace them with a single class.< / p >
2018-04-03 16:37:24 +03:00
< pre > < code > from rest_framework.decorators import action
2017-10-06 15:06:25 +03:00
from rest_framework.response import Response
2014-11-25 19:04:38 +03:00
class SnippetViewSet(viewsets.ModelViewSet):
"""
This viewset automatically provides `list`, `create`, `retrieve`,
`update` and `destroy` actions.
Additionally we also provide an extra `highlight` action.
"""
queryset = Snippet.objects.all()
serializer_class = SnippetSerializer
permission_classes = (permissions.IsAuthenticatedOrReadOnly,
IsOwnerOrReadOnly,)
2018-04-03 16:37:24 +03:00
@action(detail=True, renderer_classes=[renderers.StaticHTMLRenderer])
2014-11-25 19:04:38 +03:00
def highlight(self, request, *args, **kwargs):
snippet = self.get_object()
return Response(snippet.highlighted)
2014-12-18 16:49:50 +03:00
def perform_create(self, serializer):
2015-09-11 15:06:48 +03:00
serializer.save(owner=self.request.user)
2014-11-25 19:04:38 +03:00
< / code > < / pre >
< p > This time we've used the < code > ModelViewSet< / code > class in order to get the complete set of default read and write operations.< / p >
2018-04-03 16:37:24 +03:00
< p > Notice that we've also used the < code > @action< / code > decorator to create a custom action, named < code > highlight< / code > . This decorator can be used to add any custom endpoints that don't fit into the standard < code > create< / code > /< code > update< / code > /< code > delete< / code > style.< / p >
< p > Custom actions which use the < code > @action< / code > decorator will respond to < code > GET< / code > requests by default. We can use the < code > methods< / code > argument if we wanted an action that responded to < code > POST< / code > requests.< / p >
< p > The URLs for custom actions by default depend on the method name itself. If you want to change the way url should be constructed, you can include < code > url_path< / code > as a decorator keyword argument.< / p >
2015-11-04 17:59:23 +03:00
< h2 id = "binding-viewsets-to-urls-explicitly" > < a class = "toclink" href = "#binding-viewsets-to-urls-explicitly" > Binding ViewSets to URLs explicitly< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > The handler methods only get bound to the actions when we define the URLConf.
To see what's going on under the hood let's first explicitly create a set of views from our ViewSets.< / p >
2017-12-20 17:34:31 +03:00
< p > In the < code > snippets/urls.py< / code > file we bind our < code > ViewSet< / code > classes into a set of concrete views.< / p >
2014-11-25 19:04:38 +03:00
< pre > < code > from snippets.views import SnippetViewSet, UserViewSet, api_root
from rest_framework import renderers
snippet_list = SnippetViewSet.as_view({
'get': 'list',
'post': 'create'
})
snippet_detail = SnippetViewSet.as_view({
'get': 'retrieve',
'put': 'update',
'patch': 'partial_update',
'delete': 'destroy'
})
snippet_highlight = SnippetViewSet.as_view({
'get': 'highlight'
}, renderer_classes=[renderers.StaticHTMLRenderer])
user_list = UserViewSet.as_view({
'get': 'list'
})
user_detail = UserViewSet.as_view({
'get': 'retrieve'
})
< / code > < / pre >
< p > Notice how we're creating multiple views from each < code > ViewSet< / code > class, by binding the http methods to the required action for each view.< / p >
< p > Now that we've bound our resources into concrete views, we can register the views with the URL conf as usual.< / p >
< pre > < code > urlpatterns = format_suffix_patterns([
url(r'^$', api_root),
url(r'^snippets/$', snippet_list, name='snippet-list'),
2016-10-20 18:31:37 +03:00
url(r'^snippets/(?P< pk> [0-9]+)/$', snippet_detail, name='snippet-detail'),
url(r'^snippets/(?P< pk> [0-9]+)/highlight/$', snippet_highlight, name='snippet-highlight'),
2014-11-25 19:04:38 +03:00
url(r'^users/$', user_list, name='user-list'),
2016-10-20 18:31:37 +03:00
url(r'^users/(?P< pk> [0-9]+)/$', user_detail, name='user-detail')
2014-11-25 19:04:38 +03:00
])
< / code > < / pre >
2015-11-04 17:59:23 +03:00
< h2 id = "using-routers" > < a class = "toclink" href = "#using-routers" > Using Routers< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > Because we're using < code > ViewSet< / code > classes rather than < code > View< / code > classes, we actually don't need to design the URL conf ourselves. The conventions for wiring up resources into views and urls can be handled automatically, using a < code > Router< / code > class. All we need to do is register the appropriate view sets with a router, and let it do the rest.< / p >
2017-12-20 17:34:31 +03:00
< p > Here's our re-wired < code > snippets/urls.py< / code > file.< / p >
2014-11-25 19:04:38 +03:00
< pre > < code > from django.conf.urls import url, include
from rest_framework.routers import DefaultRouter
2017-12-20 17:34:31 +03:00
from snippets import views
2014-11-25 19:04:38 +03:00
# Create a router and register our viewsets with it.
router = DefaultRouter()
router.register(r'snippets', views.SnippetViewSet)
router.register(r'users', views.UserViewSet)
# The API URLs are now determined automatically by the router.
urlpatterns = [
2017-12-20 17:34:31 +03:00
url(r'^', include(router.urls))
2014-11-25 19:04:38 +03:00
]
< / code > < / pre >
< p > Registering the viewsets with the router is similar to providing a urlpattern. We include two arguments - the URL prefix for the views, and the viewset itself.< / p >
< p > The < code > DefaultRouter< / code > class we're using also automatically creates the API root view for us, so we can now delete the < code > api_root< / code > method from our < code > views< / code > module.< / p >
2015-11-04 17:59:23 +03:00
< h2 id = "trade-offs-between-views-vs-viewsets" > < a class = "toclink" href = "#trade-offs-between-views-vs-viewsets" > Trade-offs between views vs viewsets< / a > < / h2 >
2014-11-25 19:04:38 +03:00
< p > Using viewsets can be a really useful abstraction. It helps ensure that URL conventions will be consistent across your API, minimizes the amount of code you need to write, and allows you to concentrate on the interactions and representations your API provides rather than the specifics of the URL conf.< / p >
< p > That doesn't mean it's always the right approach to take. There's a similar set of trade-offs to consider as when using class-based views instead of function based views. Using viewsets is less explicit than building your views individually.< / p >
2016-07-14 15:05:57 +03:00
< p > In < a href = "../7-schemas-and-client-libraries/" > part 7< / a > of the tutorial we'll look at how we can add an API schema,
and interact with our API using a client library or command line tool.< / p >
2015-06-04 17:37:22 +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 >
2016-05-26 13:48:39 +03:00
< script 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 >
