https://github.com/Brobin/drf-generators

:triangular_ruler: Generate Views, Serializers, and Urls for your Django Rest Framework application
https://github.com/Brobin/drf-generators

Last synced: 5 months ago
JSON representation

:triangular_ruler: Generate Views, Serializers, and Urls for your Django Rest Framework application

• Host: GitHub
• URL: https://github.com/Brobin/drf-generators
• Owner: Brobin
• License: mit
• Created: 2015-04-07T05:06:11.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-10-19T15:37:50.000Z (over 2 years ago)
• Last Synced: 2024-04-20T12:17:36.309Z (12 months ago)
• Language: Python
• Homepage:
• Size: 98.6 KB
• Stars: 343
• Watchers: 16
• Forks: 78
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-django-rest-framework - drf-generators

README

        
==============

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.

---------------

|python| |pypi| |license| |travis| |django| |drf|

---------------

* `Installation`_

* `Usage`_

* `Serializers`_

* `Views`_

* `Urls`_

* `Tests`_

* `License`_

---------------

============

Installation

============

Install with pip:

.. code-block:: bash

    $ pip install drf-generators

or Clone the repo and install manually:

.. code-block:: bash

    $ 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.

.. code-block:: python

    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.

.. code-block:: python

    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.

.. code-block:: bash

   $ 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.

.. code-block:: bash

    $ 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``.

.. code-block:: python

    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``

.. code-block:: python

    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``

.. code-block:: python

    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``

.. code-block:: python

    @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``

.. code-block:: python

    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

----------------------------

.. code-block:: python

    router = SimpleRouter()

    router.register(r'model', views.ModelViewSet, 'Model')

    urlpatterns = router.urls

------------

APIView urls

------------

.. code-block:: python

    url(r'^model/([0-9]+)$', views.ModelAPIView.as_view()),

    url(r'^model', views.ModelAPIListView.as_view()),

-------------

Function urls

-------------

.. code-block:: python

    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 `_.

.. |python| image:: https://img.shields.io/pypi/v/drf-generators.svg?style=flat-square

    :target: https://pypi.python.org/pypi/drf-generators/

    :alt: Supported Python versions

.. |pypi| image:: https://img.shields.io/pypi/pyversions/drf-generators.svg?style=flat-square

    :target: https://pypi.python.org/pypi/drf-generators/

    :alt: Latest Version

.. |license| image:: https://img.shields.io/pypi/l/drf-generators.svg?style=flat-square

    :target: https://pypi.python.org/pypi/drf-generators/

    :alt: License

.. |travis| image:: https://img.shields.io/travis/Brobin/drf-generators.svg?style=flat-square

    :target: https://travis-ci.org/Brobin/drf-generators/

    :alt: Travis CI

.. |django| image:: https://img.shields.io/badge/Django-1.11, 2.2,3.0-orange.svg?style=flat-square

    :target: http://djangoproject.com/

    :alt: Django 1.11, 2.2, 3.0

.. |drf| image:: https://img.shields.io/badge/DRF-3.11-orange.svg?style=flat-square

    :target: http://www.django-rest-framework.org/

    :alt: DRF 3.11