DRF Generators
Writing APIs can be boring and repetitive work. Don't write another CRUDdy view in Django Rest Framework. With DRF Generators, one simple command will generate all of your Views, Serializers, and even Urls for your Django Rest Framework application!
For a full step-by-step tutorial, check out my blog post!
This is not intended to give you a production quality API. It was intended to jumpstart your development and save you from writing the same code over and over for each model.
Installation
Install with pip:
$ pip install drf-generators
or Clone the repo and install manually:
$ git clone https://github.com/brobin/drf-generators.git
$ cd drf-generators
$ python setup.py install
To use DRF Generators, add it your INSTALLED_APPS.
INSTALLED_APPS = (
...
'rest_framework',
'drf_generators',
...
)
Note: In order to use the APIView classes, you must have the rest framework DEFAULT_PAGINATION_CLASS and PAGE_SIZE set.
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 15
}
Usage
To use the generators, run the following command, where app is the application to generate an API for.
$ python manage.py generate {app} {options}
| Option | Action |
|---|---|
--serializers |
Generate only Serializers for your app. |
--views |
Generate only Views for your app. |
--urls |
Generate only urls for your app. |
--force |
Overwrite existing files without the warning prompt. |
-f, --format |
Format to use when generating views and urls. Valid options: viewset, apiview, function, modelviewset. Default: viewset. |
-d, --depth |
Serialization depth for related models. Default: 0 |
Example: Generate everything for the app api with function style views, overwriting existing files, with a serialization depth of 2.
$ python manage.py generate api --format function --force --depth=2
Serializers
Drf Generators will create serializers.py for your application. It currently uses rest framework's ModelSerializer for serialization of the models defined in models.py.
class ModelSerializer(serializers.ModelSerializer):
class Meta:
model = User
Views
DRF Generators will create views.py for your application. It can generate ViewSet, APIView and function based views. Set the --format option when running the generator to pick the preferred style
ViewSet
python manage.py generate api --format viewset
class ModelViewSet(ViewSet):
def list(self, request):
...
def create(self, request):
...
def retrieve(self, request, pk=None):
...
def update(self, request, pk=None):
...
def destroy(self, request, pk=None):
...
APIView
python manage.py generate api --format apiview
class ModelAPIView(APIView):
def get(self, request, id, format=None):
...
def put(self, request, id, format=None):
...
def delete(self, request, id, format=None):
...
class ModelAPIListView(APIView):
def get(self, request, format=None):
...
def post(self, request, format=None):
...
Function
python manage.py generate api --format function
@api_view(['GET', 'POST'])
def model_list(request):
if request.method == 'GET':
...
elif request.method == 'POST':
...
@api_view(['GET', 'PUT', 'DELETE'])
def model_detail(request, pk):
if request.method == 'GET':
...
elif request.method == 'PUT':
...
elif request.method == 'DELETE':
...
ModelViewSet
python manage.py generate api --format modelviewset
class MyModelViewSet(ModelViewSet):
queryset = MyModel.objects.all()
serializer_class = MyModelSerializer
Urls
Finally, DRF Generator will create you a default urls.py to match the View format you are using.
ViewSet & ModeViewSet Routes
router = SimpleRouter()
router.register(r'model', views.ModelViewSet, 'Model')
urlpatterns = router.urls
APIView urls
url(r'^model/([0-9]+)$', views.ModelAPIView.as_view()),
url(r'^model', views.ModelAPIListView.as_view()),
Function urls
urlpatterns = [
url(r'^model/(?P
[0-9]+)$'
, views.model_detail),
url(r'^model/$', views.model_list),
]
urlpatterns = format_suffix_patterns(urlpatterns)
Tests
A full application built with drf-generators can be found in the tests directory. Instructions on running the tests can be found in the test project's README.
License
MIT License. See LICENSE.
![[help wanted] Is is possible to set view restriction in models?](https://avatars.githubusercontent.com/u/17257805?v=4)
5.6k Dec 27, 2022
10 Nov 21, 2022
1.1k Dec 28, 2022
3k Jan 06, 2023
19 Aug 30, 2022
35 Dec 23, 2022
8 Sep 12, 2022
1 Nov 05, 2021
6 Dec 27, 2022
2.6k Dec 23, 2022
1 Dec 15, 2021
42 Dec 27, 2022
1.8k Jan 04, 2023
626 Nov 20, 2022
53 Dec 12, 2022
4 Dec 06, 2022
142 Jan 06, 2023
575 Jan 05, 2023
6.7k Dec 27, 2022