Go to file
Tom Christie 33b512b1f2 Version 3.3.1 2015-11-04 14:49:57 +00:00
.tx add config and documentation about uploading/downloading translations from Transifex 2015-01-07 11:13:03 +00:00
docs Merge pull request #3592 from tomchristie/request-parsing-when-post-accessed 2015-11-04 14:17:55 +00:00
docs_theme Add section permalinks to docs 2015-10-27 15:20:59 -05:00
requirements Update transifex-client requirement to latest release version 2015-09-14 21:05:28 -07:00
rest_framework Version 3.3.1 2015-11-04 14:49:57 +00:00
tests Add regression test for DecimalField mapping 2015-10-30 07:47:11 -04:00
.gitignore Setup isort for code style linting 2015-06-26 09:16:33 -04:00
.isort.cfg Setup isort for code style linting 2015-06-26 09:16:33 -04:00
.travis.yml Fix codecov on Travis CI 2015-10-07 22:20:46 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2015-07-22 13:05:56 +01:00
LICENSE.md Separate LICENSE and README to two files. 2015-05-05 14:48:30 +02:00
MANIFEST.in Separate LICENSE and README to two files. 2015-05-05 14:48:30 +02:00
README.md Updated readme to reflect 3.3 release 2015-10-30 13:04:44 +01:00
mkdocs.yml Merge pull request #3592 from tomchristie/request-parsing-when-post-accessed 2015-11-04 14:17:55 +00:00
requirements.txt Fix typos in comments 2015-08-19 03:55:39 +02:00
runtests.py Fix codecov on Travis CI 2015-10-07 22:20:46 -07:00
setup.cfg Set up wheel distribution support 2013-11-15 15:49:53 +00:00
setup.py Clean up after publishing to PyPI 2015-08-25 13:32:35 +01:00
tox.ini Test against Django 1.9 beta 2015-10-20 10:53:45 +01:00

README.md

Django REST framework

build-status-image coverage-status-image pypi-version

Awesome web-browsable Web APIs.

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


Note: We have now released Django REST framework 3.3. For older codebases you may want to refer to the version 2.4.4 source code, and documentation.

For more details see the 3.3 announcement and release notes.


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 browsable API

Screenshot

Requirements

  • Python (2.7, 3.2, 3.3, 3.4, 3.5)
  • Django (1.7, 1.8, 1.9)

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