Web APIs for Django, made easy.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for carltongibson from gravatar.com carltongibson Avatar for linovia from gravatar.com linovia Avatar for tomchristie from gravatar.com tomchristie

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

`Django REST framework <http://www.django-rest-framework.org/>`__
=================================================================

|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 <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 <https://github.com/tomchristie/django-rest-framework/tree/version-2.4.x>`__,
and
`documentation <http://tomchristie.github.io/rest-framework-2-docs/>`__.

For more details see the 3.3
`announcement <http://www.django-rest-framework.org/topics/3.3-announcement/>`__
and `release
notes <http://www.django-rest-framework.org/topics/release-notes/#33x-series>`__.

--------------

Overview
========

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

Some reasons you might want to use REST framework:

- The `Web browsable API <http://restframework.herokuapp.com/>`__ is a
huge usability win for your developers.
- `Authentication
policies <http://www.django-rest-framework.org/api-guide/authentication/>`__
including optional packages for
`OAuth1a <http://www.django-rest-framework.org/api-guide/authentication/#django-rest-framework-oauth>`__
and
`OAuth2 <http://www.django-rest-framework.org/api-guide/authentication/#django-oauth-toolkit>`__.
- `Serialization <http://www.django-rest-framework.org/api-guide/serializers/>`__
that supports both
`ORM <http://www.django-rest-framework.org/api-guide/serializers/#modelserializer>`__
and
`non-ORM <http://www.django-rest-framework.org/api-guide/serializers/#serializers>`__
data sources.
- Customizable all the way down - just use `regular function-based
views <http://www.django-rest-framework.org/api-guide/views/#function-based-views>`__
if you don't need the
`more <http://www.django-rest-framework.org/api-guide/generic-views/>`__
`powerful <http://www.django-rest-framework.org/api-guide/viewsets/>`__
`features <http://www.django-rest-framework.org/api-guide/routers/>`__.
- `Extensive documentation <http://www.django-rest-framework.org/>`__,
and `great community
support <https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework>`__.

There is a live example API for testing purposes, `available
here <http://restframework.herokuapp.com/>`__.

**Below**: *Screenshot from the browsable API*

.. figure:: http://www.django-rest-framework.org/img/quickstart.png
:alt: Screenshot

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 migrate
./manage.py createsuperuser

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

.. code:: python

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:

.. code:: python

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`` <http://curl.haxx.se/>`__. 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 <http://www.django-rest-framework.org/>`__.

For questions and support, use the `REST framework discussion
group <https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework>`__,
or ``#restframework`` on freenode IRC.

You may also want to `follow the author on
Twitter <https://twitter.com/_tomchristie>`__.

Security
========

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
rest-framework-security@googlegroups.com. The project maintainers will
then work with you to resolve any issues where required, prior to any
public disclosure.

.. |build-status-image| image:: https://secure.travis-ci.org/tomchristie/django-rest-framework.svg?branch=master
:target: http://travis-ci.org/tomchristie/django-rest-framework?branch=master
.. |coverage-status-image| image:: https://img.shields.io/codecov/c/github/tomchristie/django-rest-framework/master.svg
:target: http://codecov.io/github/tomchristie/django-rest-framework?branch=master
.. |pypi-version| image:: https://img.shields.io/pypi/v/djangorestframework.svg
:target: https://pypi-hypernode.com/pypi/djangorestframework

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for carltongibson from gravatar.com carltongibson Avatar for linovia from gravatar.com linovia Avatar for tomchristie from gravatar.com tomchristie

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

3.15.2

3.15.1

3.15.0

3.14.0

3.13.1

3.13.0

3.12.4

3.12.3

3.12.2

3.12.1

3.12.0

3.11.2

3.11.1

3.11.0

3.10.3

3.10.2

3.10.1

3.10.0

3.9.4

3.9.3

3.9.2

3.9.1

3.9.0

3.8.2

3.8.1

3.8.0

3.7.7

3.7.6

3.7.5

3.7.4

3.7.3

3.7.2

3.7.1

3.7.0

3.6.4

3.6.3

3.6.2

3.6.1

3.6.0

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.7

3.4.6

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

This version

3.3.3

3.3.2

3.3.1

3.3.0

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.3

3.1.2

3.1.1

3.1.0

3.0.5

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

2.4.8

2.4.7

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.14

2.3.13

2.3.12

2.3.11

2.3.10

2.3.9

2.3.8

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.17

2.1.16

2.1.15

2.1.14

2.1.13

2.1.12

2.1.11

2.1.10

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.2

2.0.1

2.0.0

0.4.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.1

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangorestframework-3.3.3.tar.gz (420.0 kB view details)

Uploaded Source

Built Distribution

djangorestframework-3.3.3-py2.py3-none-any.whl (662.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file djangorestframework-3.3.3.tar.gz.

File metadata

File hashes

Hashes for djangorestframework-3.3.3.tar.gz
Algorithm Hash digest
SHA256 f606f2bb4e9bb320937cb6ccce299991b2d302f5cc705a671dffca491e55935c
MD5 6f5ee9646e7fa87dad4385d3c7e7678d
BLAKE2b-256 239c94812ea7a7bd95af5439ab95795c03b6757a0cad30e751320f80799c8038

See more details on using hashes here.

File details

Details for the file djangorestframework-3.3.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for djangorestframework-3.3.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4f47056ad798103fc9fb049dff8a67a91963bd215d31bad12ad72b891559ab16
MD5 e2fd143f901ba78062933cc2c5b1e4e7
BLAKE2b-256 45cea626c4e178c7334fbd825612a8e72489ffca8e851a83a5941ab7923f35dd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page