Django-Conduit

Easy and powerful REST APIs for Django.

Why Use Django-Conduit?

See the full list of features.

Getting Started

Django-Conduit will automatically create your starting api based on your existing models.

  1. Install via PyPI: pip install django-conduit

  2. Add the following to your INSTALLED_APPS:

    INSTALLED_APPS = (
        ...
        'conduit',
        # 'api',
    )
    
  3. Generate your API app by running the following:

    ./manage.py create_api [name_of_your_app] --folder=api
    
  4. Uncomment ‘api’ in your INSTALLED_APPS

  5. Point your main URLconf (normally project_name/urls.py) to your new ‘api’ app:

    urlpatterns = patterns('',
        ...
        url(r'^api/', include('api.urls')),
        ...
    )
    
  6. Visit localhost:8000/api/v1/[model_name] to fetch one of your new resources!

All your new resources will be defined in api/views.py, and they will be registered with your Api object in api/urls.py.

Indices and tables