djangorestframework-extras 0.2.1

User permissions and the custom UsersViewSet

djangorestframework-extras provides a custom ViewSet UsersViewSet with serializers and permissions for the default user, the staff user and the superuser.

Register UsersViewSet through the DefaultRouter:

from rest_framework_extras.users.viewsets import UsersViewSet

router = routers.DefaultRouter()

router.register(r'users', UsersViewSet, 'user')

Discovery and registration of ViewSets

Enable discovery and registration of default serializers and viewsets by adding the following to urls.py:

from rest_framework import routers
import rest_framework_extras
router = routers.DefaultRouter()

rest_framework_extras.discover(router)
rest_framework_extras.register(router)

urlpatterns = [
    url(r"^api/(?P<version>(v1))/", include(router.urls))
]

Going through the code line by line:

1. Line 1 & 3: The router and DefaultRouter classes connects the views and urls automatically and also creates the API root.

2. Line 5: The new discover function generates default serializers and viewsets. This function should be run before normal registration.

3. Line 6: The new register function registers all viewsets (including the UsersViewSet), overriding any items already registered with the same name.

4. Line 9: Define the urls by including router.urls.

Available Settings

REST_FRAMEWORK_EXTRAS

blacklist: A dictionary of the models to blacklist. By default the following models are blacklisted:

"REST_FRAMEWORK_EXTRAS": {
   "blacklist": {
        "sessions-session": {},
        "admin-logentry": {}
   },
   "authentication-classes": (SessionAuthentication, BasicAuthentication),
   "permission-classes": (DjangoModelPermissions,)
}