Repository files navigation

Awesome web-browsable Web APIs.

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

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

For more details see the3.1 release notes

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

Some reasons you might want to use REST framework:

• TheWeb browsable API is a huge usability win for your developers.
• Authentication policies including optional packages forOAuth1a andOAuth2.
• Serialization that supports bothORM andnon-ORM data sources.
• Customizable all the way down - just useregular function-based views if you don't need themorepowerfulfeatures.
• Extensive documentation, andgreat community support.

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

Below:Screenshot from the browsable API

• Python (2.6.5+, 2.7, 3.2, 3.3, 3.4)
• Django (1.4.11+, 1.5.6+, 1.6.3+, 1.7, 1.8-beta)

Install usingpip...

pip install djangorestframework

Add'rest_framework' to yourINSTALLED_APPS setting.

INSTALLED_APPS = (    ...    'rest_framework',)

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 djangopip install djangorestframeworkdjango-admin.py startproject example ../manage.py syncdb

Now edit theexample/urls.py module in your project:

fromdjango.conf.urlsimporturl,includefromdjango.contrib.auth.modelsimportUserfromrest_frameworkimportserializers,viewsets,routers# Serializers define the API representation.classUserSerializer(serializers.HyperlinkedModelSerializer):classMeta:model=Userfields= ('url','username','email','is_staff')# ViewSets define the view behavior.classUserViewSet(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 yoursettings.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 athttp://127.0.0.1:8000/, and view your new 'users' API. If you use theLogin 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 ascurl. 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,}

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

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

You may also want tofollow the author on Twitter.

If you believe you’ve found something in Django REST framework which has security implications, pleasedo not raise the issue in a public forum.

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

Copyright (c) 2011-2015, Tom ChristieAll rights reserved.

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

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

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