# djangorestframework

> Web APIs for Django, made easy.

- **URL**: https://www.freshcrate.ai/projects/djangorestframework
- **Author**: pypi
- **Category**: Frameworks
- **Latest version**: `3.17.1` (2026-04-21)
- **License**: Unknown
- **Source**: https://github.com/encode/django-rest-framework
- **Homepage**: https://pypi.org/project/djangorestframework/
- **Language**: Python
- **GitHub**: 29,984 stars, 7,066 forks
- **Registry**: pypi (`djangorestframework`)
- **Tags**: `pypi`

## Description

# [Django REST framework][docs]

[![build-status-image]][build-status]
[![coverage-status-image]][codecov]
[![pypi-version]][pypi]

**Awesome web-browsable Web APIs.**

Full documentation for the project is available at [https://www.django-rest-framework.org/][docs].

---

# 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 is a huge usability win for your developers.
* [Authentication policies][authentication] including optional packages for [OAuth1a][oauth1-section] and [OAuth2][oauth2-section].
* [Serialization][serializers] that supports both [ORM][modelserializer-section] and [non-ORM][serializer-section] data sources.
* Customizable all the way down - just use [regular function-based views][functionview-section] if you don't need the [more][generic-views] [powerful][viewsets] [features][routers].
* [Extensive documentation][docs], and [great community support][group].

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

![Screenshot][image]

----

# Requirements

* Python 3.10+
* Django 4.2, 5.0, 5.1, 5.2, 6.0

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.

```python
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.

Start 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:

```python
from django.contrib.auth.models import User
from django.urls import include, path
from rest_framework import routers, serializers, viewsets


# 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 = [
    path("", include(router.urls)),
    path("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:

```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`](https://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 [https://www.django-rest-framework.org/][docs].

For questions and support, use the [REST framework discussion group][group], or `#restframework` on libera.chat IRC.

# Security

Please see the [security policy][security-policy].

[build-status-image]: https://github.com/encode/django-rest-framework/actions/workflows/main.yml/badge.svg
[build-status]: https://github.com/encode/django-rest-framework/actions/workflows/main.yml
[coverage-status-image]: https://img.shields.io/codecov/c/github/encode/django-rest-framework/main.svg
[codecov]: https://codecov.io/github/encode/django-rest-framework?branch=main
[pypi-version]: h

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `3.17.1` | 2026-04-21 | Low | Imported from PyPI (3.17.1) |
| `3.15.0` | 2026-04-19 | High | ## What's Changed  _Released 15th March 2024_  * Django 5.0 and Python 3.12 support [[#9157](https://github.com/encode/django-rest-framework/pull/9157)] * Use POST method instead of GET to perform logout in browsable API [[9208](https://github.com/encode/django-rest-framework/pull/9208)] * Added jQuery 3.7.1 support & dropped previous version [[#9094](https://github.com/encode/django-rest-framework/pull/9094)] * Use str as default path converter [[#9066](https://github.com/encode/django-r |
| `3.17.0` | 2026-03-18 | Low | <!-- Release notes generated using configuration in .github/release.yml at 3.17.0 -->  ## What's Changed ### Breaking changes * Drop support for Python 3.9 by @auvipy in https://github.com/encode/django-rest-framework/pull/9781 * Drop deprecated coreapi support by @browniebroke in https://github.com/encode/django-rest-framework/pull/9895 ### Features * Add ability to specify output format for `DurationField` by @sevdog in https://github.com/encode/django-rest-framework/pull/8532 * Add missing de |
| `3.16.1` | 2025-08-06 | Low | This release fixes a few bugs, clean-up some old code paths for unsupported Python versions and improve translations.  ## Minor changes  * Cleanup optional `backports.zoneinfo` dependency and conditions on unsupported Python 3.8 and lower in [#9681](https://github.com/encode/django-rest-framework/pull/9681). Python versions prior to 3.9 were already unsupported so this isn't considered as a breaking change.  ## Bug fixes  * Fix regression in `unique_together` validation with `SerializerM |
| `3.16.0` | 2025-03-28 | Low | This release is considered a significant release to improve upstream support with Django and Python. Some of these may change the behaviour of existing features and pre-existing behaviour. Specifically, some fixes were added to around the support of `UniqueConstraint` with nullable fields which will improve built-in serializer validation.  ## Features  * Add official support for Django 5.1 and its new `LoginRequiredMiddleware` in [#9514](https://github.com/encode/django-rest-framework/pull/9 |
| `3.15.2` | 2024-12-28 | Low | ## What's Changed * Add @api_view example to caching documentation by @BradWells in https://github.com/encode/django-rest-framework/pull/9131 * Update docstring by @jthevos in https://github.com/encode/django-rest-framework/pull/9340 * Apply black formatting to caching markdown by @jthevos in https://github.com/encode/django-rest-framework/pull/9341 * Update renderers documentation example by @mgaligniana in https://github.com/encode/django-rest-framework/pull/9362 * Removing live examples |
| `3.15.1` | 2024-05-06 | Low | ## What's Changed * Update the message to be consistent with the Django `HttpResponseBa… by @maycuatroi in https://github.com/encode/django-rest-framework/pull/9287 * Make `inflection` package truly optional by @browniebroke in https://github.com/encode/django-rest-framework/pull/9303 * Fix broken links in release notes for 3.15 by @browniebroke in https://github.com/encode/django-rest-framework/pull/9305 * TokenAdmin.autocomplete_fields Breaks Some Use Cases, Revert by @alexdlaird in https: |
| `3.14.0` | 2022-11-08 | Low | * Django 2.2 is no longer supported. #8662 * Django 4.1 compatibility. #8591 * Add `--api-version` CLI option to `generateschema` management command. #8663 * Enforce `is_valid(raise_exception=False)` as a keyword-only argument. #7952 * Stop calling `set_context` on Validators. #8589 * Return `NotImplemented` from `ErrorDetails.__ne__`. #8538 * Don't evaluate `DateTimeField.default_timezone` when a custom timezone is set. #8531 * Make relative URLs clickable in Browseable API. #8464 * Sup |
| `3.13.1` | 2022-11-08 | Low | * Revert schema naming changes with function based `@api_view`. #8297 |
| `3.13.0` | 2022-11-08 | Low | * Django 4.0 compatability. #8178 * Add `max_length` and `min_length` options to `ListSerializer`. #8165 * Add `get_request_serializer` and `get_response_serializer` hooks to `AutoSchema`. #7424 * Fix OpenAPI representation of null-able read only fields. #8116 * Respect `UNICODE_JSON` setting in API schema outputs. #7991 * Fix for `RemoteUserAuthentication`. #7158 * Make Field constructors keyword-only. #7632 |

## Citation

- HTML: https://www.freshcrate.ai/projects/djangorestframework
- Markdown: https://www.freshcrate.ai/projects/djangorestframework.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/djangorestframework/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._