Python HTML CSS JavaScript
Latest commit 3eade5a Jul 21, 2017 @jpadilla jpadilla committed on GitHub Merge pull request #5285 from minusf/master
typo: may -> many

Django REST framework

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

Awesome web-browsable Web APIs.

Full documentation for the project is available at


REST framework is a collaboratively funded project. If you use REST framework commercially we strongly encourage you to invest in its continued development by signing up for a paid plan.

The initial aim is to provide a single full-time position on REST framework. Every single sign-up makes a significant impact towards making that possible.

Many thanks to all our wonderful sponsors, and in particular to our premium backers, Rover, Sentry, Stream, Machinalis, and Rollbar.


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



  • Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
  • Django (1.8, 1.9, 1.10, 1.11)


Install using pip...

pip install djangorestframework

Add 'rest_framework' to your INSTALLED_APPS setting.



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 startproject example .
./ migrate
./ createsuperuser

Now edit the example/ 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 module:

    ...  # Make sure to include the default installed apps here.

    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.

That's it, we're done!

./ runserver

You can now open the API in your browser at, 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
        "url": "",
        "username": "admin",
        "email": "",
        "is_staff": true,

Or to create a new user:

$ curl -X POST -d username=new -d -d is_staff=false -H 'Accept: application/json; indent=4' -u admin:password
    "url": "",
    "username": "new",
    "email": "",
    "is_staff": false,

Documentation & Support

Full documentation for the project is available at

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.


If you believe you've 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 The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.