encode/django-rest-framework


Web APIs for Django. ⚡️

https://www.django-rest-framework.org

License: Other

Language: Python

Keywords: api, django, python, rest


Django REST framework

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

Awesome web-browsable Web APIs.

Full documentation for the project is available at https://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.

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, Sentry, Stream, Rollbar, Cadre, Kloudless, ESG, and Lights On Software.


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 (3.5, 3.6, 3.7)
  • Django (1.11, 2.0, 2.1, 2.2)

We highly recommend and only officially support the latest patch release of each Python and Django series.

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

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 https://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

Please see the security policy.

Project Statistics

Sourcerank 18
Repository Size 42.8 MB
Stars 15,289
Forks 4,473
Watchers 554
Open issues 197
Dependencies 19
Contributors 679
Tags 118
Created
Last updated
Last pushed

Top Contributors See all

Tom Christie Xavier Ordoquy José Padilla Check your git settings! Stephan Groß Marko Tibold Carlton Gibson Asif Saif Uddin Dougal Matthews Jon Dufresne Mark Aaron Shirley Artem Muterko Yuri Prezument Ryan P Kilby Alec Perkins Jamie Matthews Daniel Hahler Tymur Maryokhin Craig Blaszczyk Pierre Dulac

Packages Referencing this Repo

djangorestframework
Web APIs for Django, made easy.
Latest release 3.10.3 - Updated - 15.3K stars

Recent Tags See all

3.10.3 September 04, 2019
3.10.2 July 29, 2019
3.10.1 July 17, 2019
3.10.0 July 15, 2019
3.9.4 May 10, 2019
3.9.3 April 29, 2019
3.9.2 March 03, 2019
3.9.1 January 16, 2019
3.9.0 October 18, 2018
3.8.2 April 06, 2018
3.8.1 April 04, 2018
3.8.0 April 03, 2018
3.7.7 December 21, 2017
3.7.6 December 21, 2017
3.7.5 December 21, 2017

Interesting Forks See all

Tivix/django-rest-framework
Web APIs for Django.
Python - Last pushed - 4 stars - 1 forks
dbrgn/django-rest-framework
Django REST framework makes it easy to build well-connected, self-describing RESTful Web APIs.
Python - Other - Last pushed - 2 stars
sloria/django-rest-framework
Web APIs for Django.
Python - Other - Last pushed - 1 stars
yuzhihuanwanglin/django-rest-framework
Web APIs for Django. ⚡️
Python - Other - Updated - 1 stars
robromano/django-rest-framework
Django REST framework makes it easy to build well-connected, self-describing RESTful Web APIs.
Python - BSD-2-Clause - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-07-29 13:57:58 UTC

Login to resync this repository