Web APIs for Django. 🎸
Go to file
codetriage-readme-bot dd73cc3a6e Add CodeTriage badge to encode/django-rest-framework
Adds a badge showing the number of people helping this repo on CodeTriage.

[![Open Source Helpers](https://www.codetriage.com/encode/django-rest-framework/badges/users.svg)](https://www.codetriage.com/encode/django-rest-framework)

## What is CodeTriage?

CodeTriage is an Open Source app that is designed to make contributing to Open Source projects easier. It works by sending subscribers a few open issues in their inbox. If subscribers get busy, there is an algorithm that backs off issue load so they do not get overwhelmed

[Read more about the CodeTriage project](https://www.codetriage.com/what).

## Why am I getting this PR?

Your project was picked by the human, @schneems. They selected it from the projects submitted to https://www.codetriage.com and hand edited the PR. How did your project get added to [CodeTriage](https://www.codetriage.com/what)? Roughly 9 months ago, [smartfin](https://github.com/smartfin) added this project to CodeTriage in order to start contributing. Since then, 8 people have subscribed to help this repo.

## What does adding a badge accomplish?

Adding a badge invites people to help contribute to your project. It also lets developers know that others are invested in the longterm success and maintainability of the project.

You can see an example of a CodeTriage badge on these popular OSS READMEs:

- [![](https://www.codetriage.com/rails/rails/badges/users.svg)](https://www.codetriage.com/rails/rails) https://github.com/rails/rails
- [![](https://www.codetriage.com/crystal-lang/crystal/badges/users.svg)](https://www.codetriage.com/crystal-lang/crystal) https://github.com/crystal-lang/crystal

## Have a question or comment?

While I am a bot, this PR was manually reviewed and monitored by a human - @schneems. My job is writing commit messages and handling PR logistics.

If you have any questions, you can reply back to this PR and they will be answered by @schneems. If you do not want a badge right now, no worries, close the PR, you will not hear from me again.

Thanks for making your project Open Source! Any feedback is greatly appreciated.
2018-02-19 10:27:53 -06:00
.tx Clean up all whitespace throughout project (#5578) 2017-11-09 20:57:53 +01:00
docs Two new tutorials (#5837) 2018-02-19 07:19:42 +00:00
docs_theme Replace background-attachment: fixed in docs (#5777) 2018-01-30 09:08:06 +01:00
licenses Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
requirements Upgrade isort (#5817) 2018-02-14 20:12:14 +00:00
rest_framework Made TemplateHTMLRenderer render IntegerField inputs when value is 0. (#5834) 2018-02-16 16:48:20 +01:00
tests Made TemplateHTMLRenderer render IntegerField inputs when value is 0. (#5834) 2018-02-16 16:48:20 +01:00
.editorconfig Clean up all whitespace throughout project (#5578) 2017-11-09 20:57:53 +01:00
.gitignore Clean up all whitespace throughout project (#5578) 2017-11-09 20:57:53 +01:00
.travis.yml Add 'dist' build (#5656) 2017-12-14 11:48:03 +01:00
codecov.yml Live API documentation (#4755) 2017-03-03 15:24:37 +00:00
CONTRIBUTING.md Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
ISSUE_TEMPLATE.md Create issue and pull request templates 2016-02-22 11:17:02 -04:00
LICENSE.md Created Tutorials and Resources, cleaned up Third Party Packages (#4910) 2017-02-24 12:55:34 +00:00
MANIFEST.in Fix typo to bring locale back to installed files 2017-12-21 12:12:08 +01:00
mkdocs.yml Version 3.7: Announcement etc (#5437) 2017-10-06 13:18:31 +02:00
PULL_REQUEST_TEMPLATE.md Update links after moving to encode org 2017-04-07 10:28:35 -04:00
README.md Add CodeTriage badge to encode/django-rest-framework 2018-02-19 10:27:53 -06:00
requirements.txt Fix typos in comments 2015-08-19 03:55:39 +02:00
runtests.py Upgrade isort (#5817) 2018-02-14 20:12:14 +00:00
setup.cfg Upgrade isort (#5817) 2018-02-14 20:12:14 +00:00
setup.py Upgrade isort (#5817) 2018-02-14 20:12:14 +00:00
tox.ini Test staticfiles (#5701) 2018-01-02 11:35:56 +01:00

Django REST framework

build-status-image coverage-status-image pypi-version Gitter Open Source Helpers

Awesome web-browsable Web APIs.

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

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.


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 (2.7, 3.4, 3.5, 3.6)
  • Django (1.10, 1.11, 2.0)

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:

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

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.