There is no urgent need to change anything as backward compatibility is retained. That being said we ask you to change usage from old endpoints to new ones for the warm fuzzy feeling of being more RESTful :)
The stable release has introduced a number of backward incompatible changes and purpose of this guide is to allow developer to quickly adapt a given project.
As mentioned in Emails page since 1.0 email support has been removed from Djoser and it is advised to use django-templated-mail for use cases which were previously handled by djoser email support. You can find out more about it in the project documentation. Keep in mind that DOMAIN
and SITE_NAME
settings have also been moved to django-templated-mail as described in settings page.
Previously djoser.urls.base
were bundled with djoser.urls.authtoken
, however in some cases developer might not need them and therefore if base URLs are needed it is now necessary to explicitly include them, e.g.:
urlpatterns = [
(...),
url(r'^auth/', include('djoser.urls')),
url(r'^auth/', include('djoser.urls.authtoken')),
]
Support for Django 1.8 and 1.9 has been dropped in Django REST Framework 3.7 and hence there was no reason to keep it in djoser. It is recommended to upgrade to Django 1.11, since 1.10 will EOL in December 2017. Django Deprecation Timeline and Django Release Notes are very helpful in the process.
Also please note that for sake of consistency all URLs now end with a trailing slash. The trailing slash is optional to ensure compatibility with frontend tools that strip the trailing slash (eg Google's Chrome browser and Angular framework).
View class names:
RegistrationView
has been renamed toUserCreateView
LoginView
has been renamed toTokenCreateView
LogoutView
has been renamed toTokenDestroyView
Base URLs:
register/
has been renamed tousers/create/
register
URL name has been renamed touser-create
activate/
has been renamed tousers/activate/
activate
URL name has been renamed touser-activate
Token Based Authentication URLs:
login/
has been renamed totoken/create/
login
URL name has been renamed totoken-create
logout/
has been renamed totoken/destroy/
logout
URL name has been renamed totoken-destroy