From 73c38b0bcbc8cb51b383e9c10b3a0e4ed87ae74d Mon Sep 17 00:00:00 2001 From: Omer Katz Date: Sun, 21 Dec 2014 22:21:14 +0200 Subject: [PATCH] Added more common usage examples of including routers in urlpatterns. This is an alternative to #2333. --- docs/api-guide/routers.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/api-guide/routers.md b/docs/api-guide/routers.md index 6819adb6a..2512c6bab 100644 --- a/docs/api-guide/routers.md +++ b/docs/api-guide/routers.md @@ -21,6 +21,32 @@ Here's an example of a simple URL conf, that uses `SimpleRouter`. router.register(r'accounts', AccountViewSet) urlpatterns = router.urls +A more common usage of routers is + + from django.conf.urls import patterns, include, url + from rest_framework import routers + + router = routers.SimpleRouter() + router.register(r'users', UserViewSet) + router.register(r'accounts', AccountViewSet) + + urlpatterns = patterns('', + url(r'^', include(router.urls)) + ) + +It is possible to namespace the router's views using Django's standard namespacing mechanism: + + from django.conf.urls import patterns, include, url + from rest_framework import routers + + router = routers.SimpleRouter() + router.register(r'users', UserViewSet) + router.register(r'accounts', AccountViewSet) + + urlpatterns = patterns('', + url(r'^', include(router.urls, namespace='api')) + ) + There are two mandatory arguments to the `register()` method: * `prefix` - The URL prefix to use for this set of routes.