Improved example documentation regarding router includes to avoid common new user use-case with namespaces.

This commit is contained in:
Ian MacLeod 2015-11-17 17:50:05 -08:00
parent 9c7411cfc1
commit f1c5e197ec

View File

@ -135,7 +135,7 @@ Here's our project's root `urls.py` module:
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]
Do not use a namespace when you include your router urls as they are not currently supported. You can now open the API in your browser at [http://127.0.0.1:8000/](http://127.0.0.1:8000/), and view your new 'users' API. If you use the login control in the top right corner you'll also be able to add, create and delete users from the system.
If you choose to use a namespace when including your router urls you will need to do some additional work, as documented in [Using include with routers](http://www.django-rest-framework.org/api-guide/routers/#using-include-with-routers). You can now open the API in your browser at [http://127.0.0.1:8000/](http://127.0.0.1:8000/), and view your new 'users' API. If you use the login control in the top right corner you'll also be able to add, create and delete users from the system.
## Quickstart