django-restify
requires django-rest-framework
. It will create RESTFul endpoints for all models that are enabled in your project.
pip install django_restify
Install django-rest-framework and django_restify.
Activate
django-rest-framework
anddjango_restify
by adding it inINSTALLED_APP
of your django settingsINSTALLED_APP = ( 'django.contrib.auth', (...), 'rest_framework', 'django_restify' )
Configure
urls.py
:Import
django_restify.router:
from django_restify.restify import router
Configure URL:
urlpatterns = [ url(r'^admin/', include(admin.site.urls)), (.......), url(r'^api/v1/', include(router.urls)), ]
RESTIFY = {
'MODELS': [],
'IGNORE_LIST': [],
'USER_VIEWSET': '',
'NEW_USER_ACTIVE': True,
'SERIALIZERS': {
'model': {},
},
'VIEWSETS': {
'entry': {},
}
}
The list of models that you want create REST end-point. It will ingnore all other models and create end points models as listed in MODELS
. IGNORE_LIST
will get higher precedence over MODELS
.
The modules to be ignored (in list format). It can accept regular expression. For example, the default ignore list looks like:
['^django*', '^api$', '^rest_framework*', '^auth*']
To use custom viewset for user model
Set new registered user as active.
To use custom serializers for a model. It should be in dictionary format e.g. {'model': 'package.serializers.ModelSerializer'}
To use custom viewsets for a model. It should be dictionary format e.g. {'model': 'package.viewsets.ModelViewSet'}