django-autorest 0.2.1

A re-useable Django app for automatically building a REST API based on models.

AutoREST

Documentation: https://django-autorest.readthedocs.io

Source: https://github.com/gregschmit/django-autorest

PyPI: https://pypi.org/project/django-autorest/

AutoREST is a reusable Django app for building REST APIs from model definitions and (optionally) admin.py definitions.

The Problem: Building APIs for models is boring.

The Solution: This app builds them for you, optionally using your AdminSite as a guide, and you can just focus on the custom stuff.

How to Use

$ pip install django-autorest

Include autorest in your INSTALLED_APPS.

Settings

• AUTOREST_ADMIN_SITE (default 'django.contrib.admin.site'): This is an import string to the admin site where autorest can get hints on how the API should be configured (e.g., list display fields, edit fields, readonly fields, etc). To disable this feature entirely, just set this to False.

• AUTOREST_DEFAULT_USE_ADMIN_SITE (default False): Whether the default model functionality should be to get config hints from admin.py.

• AUTOREST_DEFAULT_ENABLE (default: True): Whether API ViewSets/URLs should be built for models which don’t have an explicit entry in the AUTOREST_CONFIG. If this option is False, then only models defined in the AUTOREST_CONFIG will have URLs generated for them.

• AUTOREST_CONFIG (default: {'auth':{'User':{'use_admin_site': True}}}): This is a dictionary of apps, then a dictionary of models, and then a dictionary of configuration options:

  • use_admin_site: Whether to use the admin site to build the API.

  • serializer: An import string to a serializer instance.

  • list_serializer: An import string to a serializer instance (usually providing less fields available in the listing).

  • viewset: An import string to a full viewset for this model.

Contributing

Email [e-mail] if you want to contribute. You must only contribute code that you have authored or otherwise hold the copyright to, and you must make any contributions to this project available under the MIT license.

To collaborators: don’t push using the --force option.

Dev Quickstart

AutoREST comes with a settings.py file, technically making it a Django project as well as a Django app. First clone, the repository into a location of your choosing:

$ git clone https://github.com/gregschmit/django-autorest

Then you can go into the django-autorest directory and do the initial migrations and run the server (you may need to type python3 rather than python):

$ cd django-autorest
$ python manage.py migrate
$ python manage.py createsuperuser
...
$ python manage.py runserver

Then you can see the api at http://127.0.0.1:8000/api/.

To Do

• Build endpoints based on admin.py configuration (this should be optional, using a settings.py switch, like AUTOREST_USE_ADMIN_PY) - Rigth now, simple models like the auth.Group work, however complex models like the auth.User don’t because the create API endpoint should take password/confirmation not the raw password hash.

• Build CRUD forms for the endpoints (maybe a generator)