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

Adjust phrasing.

Browse Source
This commit is contained in:
Carlton Gibson 2018-02-22 13:41:08 +01:00
parent 3ba3f45ff2
commit e88d46a4db
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -72,20 +72,19 @@ Alternatively you can use Django's `include` function, like so…
url(r'^', include(router.urls)),
]
Router URL patterns can also be included using _application_ and _instance_ namespaces.
To use an _application namespace_ pass a 2-tuple containing the `router.urls` and the app name.
To use an _instance namespace_ pass the optional `namespace` parameter.
To include the router URL patterns with an application namespace pass a
`(router.urls, app_name)` 2-tuple to `include`.
For example:
urlpatterns = [
url(r'^forgot-password/$', ForgotPasswordFormView.as_view()),
url(r'^api/', include((router.urls, 'app_name'), namespace='instance_name')),
url(r'^api/', include((router.urls, 'app_name')),
]
If you pass the optional `namespace` parameter to create an _instance namespace_ then you **must** provide the _application namespace_ as well.
See Django's [URL namespaces docs][url-namespace-docs] for more.
(`include` also allows an optional `namespace` parameter to also create an _instance namespace_.
This defaults to `None` and will be set to `app_name` if not provided.
See Django's [URL namespaces docs][url-namespace-docs] 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.