Web APIs for Django, made easy.
Project description
`Django REST framework <http://www.django-rest-framework.org/>`__
=================================================================
|build-status-image| |coverage-status-image| |pypi-version| |Gitter|
**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/>`__.
--------------
Funding
=======
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 <https://fund.django-rest-framework.org/topics/funding/>`__**.
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.*
.. raw:: html
<p align="center">
.. raw:: html
</p>
*Many thanks to all our `wonderful
sponsors <https://fund.django-rest-framework.org/topics/funding/#our-sponsors>`__,
and in particular to our premium backers,
`Rover <http://jobs.rover.com/>`__,
`Sentry <https://getsentry.com/welcome/>`__,
`Stream <https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf>`__,
`Machinalis <https://hello.machinalis.co.uk/>`__, and
`Rollbar <https://rollbar.com/>`__.*
--------------
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, 3.6)
- Django (1.8, 1.9, 1.10, 1.11)
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/encode/django-rest-framework.svg?branch=master
:target: http://travis-ci.org/encode/django-rest-framework?branch=master
.. |coverage-status-image| image:: https://img.shields.io/codecov/c/github/encode/django-rest-framework/master.svg
:target: http://codecov.io/github/encode/django-rest-framework?branch=master
.. |pypi-version| image:: https://img.shields.io/pypi/v/djangorestframework.svg
:target: https://pypi-hypernode.com/pypi/djangorestframework
.. |Gitter| image:: https://badges.gitter.im/tomchristie/django-rest-framework.svg
:target: https://gitter.im/tomchristie/django-rest-framework?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
=================================================================
|build-status-image| |coverage-status-image| |pypi-version| |Gitter|
**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/>`__.
--------------
Funding
=======
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 <https://fund.django-rest-framework.org/topics/funding/>`__**.
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.*
.. raw:: html
<p align="center">
.. raw:: html
</p>
*Many thanks to all our `wonderful
sponsors <https://fund.django-rest-framework.org/topics/funding/#our-sponsors>`__,
and in particular to our premium backers,
`Rover <http://jobs.rover.com/>`__,
`Sentry <https://getsentry.com/welcome/>`__,
`Stream <https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf>`__,
`Machinalis <https://hello.machinalis.co.uk/>`__, and
`Rollbar <https://rollbar.com/>`__.*
--------------
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, 3.6)
- Django (1.8, 1.9, 1.10, 1.11)
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/encode/django-rest-framework.svg?branch=master
:target: http://travis-ci.org/encode/django-rest-framework?branch=master
.. |coverage-status-image| image:: https://img.shields.io/codecov/c/github/encode/django-rest-framework/master.svg
:target: http://codecov.io/github/encode/django-rest-framework?branch=master
.. |pypi-version| image:: https://img.shields.io/pypi/v/djangorestframework.svg
:target: https://pypi-hypernode.com/pypi/djangorestframework
.. |Gitter| image:: https://badges.gitter.im/tomchristie/django-rest-framework.svg
:target: https://gitter.im/tomchristie/django-rest-framework?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file djangorestframework-3.6.4.tar.gz.
File metadata
- Download URL: djangorestframework-3.6.4.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | de8ac68b3cf6dd41b98e01dcc92dc0022a5958f096eafc181a17fa975d18ca42 |
|
| MD5 | 383262a7f4d641423ab01f34a0a3ae1c |
|
| BLAKE2b-256 | c4058106de162e94ad30fdd42b4f77dcb76c656fd3f51a9c01fdbbc307fd2447 |
File details
Details for the file djangorestframework-3.6.4-py2.py3-none-any.whl.
File metadata
- Download URL: djangorestframework-3.6.4-py2.py3-none-any.whl
- Upload date:
- Size: 1.5 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0f9bfbac702f3376dfb2db4971ad8af4e066bfa35393b1b85e085f7e8b91189a |
|
| MD5 | 1a5da21b14b604fc330ae9ebd1c3cc07 |
|
| BLAKE2b-256 | 122298d2ea3089384b88f1ed86fb2799d8c57b59ce430c3972ec0f18986cd449 |
