encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-23 13:44:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Provide both app and instance namespace examples

Browse Source
This commit is contained in:
Carlton Gibson 2018-03-06 09:08:37 +01:00
parent a0528fdaf5
commit 8f821dc437
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/api-guide/routers.md
View File

@ -72,18 +72,21 @@ Alternatively you can use Django's `include` function, like so…
url(r'^', include(router.urls)),
]
To include the router URL patterns with an application namespace pass a
`(router.urls, 'app_name')` 2-tuple to `include`.
For example:
You may use `include` with an application namespace:
urlpatterns = [
url(r'^forgot-password/$', ForgotPasswordFormView.as_view()),
url(r'^api/', include((router.urls, 'app_name'))),
]
(You may additionally pass an optional `namespace` parameter to `include` to also
create an _instance namespace_. See Django's [URL namespaces docs][url-namespace-docs] for more details.)
Or both an application and instance namespace:
urlpatterns = [
url(r'^forgot-password/$', ForgotPasswordFormView.as_view()),
url(r'^api/', include((router.urls, 'app_name'), namespace='instance_name')),
]
See Django's [URL namespaces docs][url-namespace-docs] and the [`include` API reference][include-api-reference] for more details.
If using namespacing with hyperlinked serializers you'll also need to ensure that any `view_name` parameters on the serializers correctly reflect the namespace.
In the example above you'd need to include a parameter such as `view_name='app_name:user-detail'` for serializer fields hyperlinked to the user detail view.