Web APIs for Django. 🎸
Go to file
2014-09-14 10:19:54 -04:00
docs Update third-party-resources.md 2014-09-14 10:19:54 -04:00
rest_framework Merge pull request #1852 from GVRV/bugfix/apiroot_get_regression 2014-09-09 07:19:16 +02:00
tests Merge pull request #1844 from adamsc64/issue_1533 2014-09-08 10:15:26 +01:00
.gitignore Fix compat datetime import when oauth2 provide does not support timezone aware datetimes 2013-06-28 09:35:52 +01:00
.travis.yml Install tox correctly 2014-09-05 17:56:25 -07:00
CONTRIBUTING.md Correct testing documentation details. 2014-09-01 12:14:26 +03:00
MANIFEST.in Exclude the pyc, pyo files and __pycache__ directories from packaging (thanks to Kevin Brown). 2014-08-31 03:39:34 +02:00
mkdocs.py Include third party resources link in home page 2014-09-13 16:20:16 -04:00
README.md Update README.md 2014-08-29 14:01:54 +01:00
requirements-test.txt Add flake8 to requirements 2014-08-19 13:42:01 +01:00
requirements.txt Update requirements.txt 2014-09-05 13:19:47 +01:00
runtests.py Code linting and added runtests.py 2014-08-19 13:28:07 +01:00
setup.cfg Set up wheel distribution support 2013-11-15 15:49:53 +00:00
setup.py Support for running the test suite with py.test 2014-03-02 12:40:30 +01:00
tox.ini Test with released Django 1.7 2014-09-03 09:58:21 -07:00

Django REST framework

build-status-image

Awesome web-browseable Web APIs.

Note: Full documentation for the project is available at http://www.django-rest-framework.org.

Overview

Django REST framework is a powerful and flexible toolkit for building Web APIs.

Some reasons you might want to use REST framework:

There is a live example API for testing purposes, available here.

Below: Screenshot from the browseable API

Screenshot

Requirements

  • Python (2.6.5+, 2.7, 3.2, 3.3)
  • Django (1.4.2+, 1.5, 1.6, 1.7)

Installation

Install using pip...

pip install djangorestframework

Add 'rest_framework' to your INSTALLED_APPS setting.

INSTALLED_APPS = (
    ...
    'rest_framework',
)

Example

Let's take a look at a quick example of using REST framework to build a simple model-backed API for accessing users and groups.

Startup up a new project like so...

pip install django
pip install djangorestframework
django-admin.py startproject example .
./manage.py syncdb

Now edit the example/urls.py module in your project:

from django.conf.urls import url, include
from django.contrib.auth.models import User
from rest_framework import serializers, viewsets, routers

# Serializers define the API representation.
class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ('url', 'username', 'email', 'is_staff')


# ViewSets define the view behavior.
class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    
# Routers provide a way of automatically determining the URL conf.
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)


# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browseable API.
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

We'd also like to configure a couple of settings for our API.

Add the following to your settings.py module:

INSTALLED_APPS = (
    ...  # Make sure to include the default installed apps here.
    'rest_framework',        
)

REST_FRAMEWORK = {
    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
    ]
}

That's it, we're done!

./manage.py runserver

You can now open the API in your browser at http://127.0.0.1:8000/, and view your new 'users' API. If you use the Login control in the top right corner you'll also be able to add, create and delete users from the system.

You can also interact with the API using command line tools such as curl. For example, to list the users endpoint:

$ curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
[
    {
        "url": "http://127.0.0.1:8000/users/1/", 
        "username": "admin", 
        "email": "admin@example.com", 
        "is_staff": true, 
    }
]

Or to create a new user:

$ curl -X POST -d username=new -d email=new@example.com -d is_staff=false -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
{
    "url": "http://127.0.0.1:8000/users/2/", 
    "username": "new", 
    "email": "new@example.com", 
    "is_staff": false, 
}

Documentation & Support

Full documentation for the project is available at http://www.django-rest-framework.org.

For questions and support, use the REST framework discussion group, or #restframework on freenode IRC.

You may also want to follow the author on Twitter.

Security

If you believe youve found something in Django REST framework which has security implications, please do not raise the issue in a public forum.

Send a description of the issue via email to rest-framework-security@googlegroups.com. The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.

License

Copyright (c) 2011-2014, Tom Christie All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.