djangorestframework-jsonapi
A Django REST framework API adapter for the JSON:API spec.
Decision gist · record as of 2026-08-14
Yes. If you are building a Django REST framework API and need or want JSON:API compliance, this is the standard adapter for that job. It has low install friction, active maintenance, no known vulnerabilities, and a permissive license. It integrates cleanly with DRF's existing patterns and is well-established (since 2015). Install it if JSON:API format is a requirement or a deliberate choice for your API design.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Django 4.2+ and Django REST framework 3.15+; Python 3.9 or later.
- Low friction install with three straightforward runtime dependencies (django, djangorestframework, inflection).
- Actively maintained with recent commits and no known vulnerabilities.
License · maintenance · safety
BSD (permissive) — BSD permissive license allows use in commercial and private projects with minimal restrictions—typical for web framework extensions.
last release 2025-10-17 (301 days) · last repo commit 2026-08-02 · 1,252 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 368,208 downloads/mo, #7,190 on PyPI
Alternatives
Verify before relying
pip install djangorestframework-jsonapi
# In settings.py, add to INSTALLED_APPS after rest_framework:
INSTALLED_APPS = [
'rest_framework',
'rest_framework_json_api',
]
# Configure REST_FRAMEWORK to use JSON:API renderers and parsers:
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': (
'rest_framework_json_api.renderers.JSONRenderer',
),
'DEFAULT_PARSER_CLASSES': (
'rest_framework_json_api.parsers.JSONParser',
),
}- Whether optional integrations (django-filter, django-polymorphic) are tested against all supported versions or only the latest.
- Performance characteristics when handling large result sets or deeply nested relationships.
What it is and what it does
This package bridges Django REST framework and the JSON:API specification, transforming DRF's default response format into JSON:API-compliant output. Instead of a flat results array, it structures responses with typed data objects, relationships, links, and metadata according to the JSON:API standard. It handles automatic key inflection (converting Python snake_case to JSON:API hyphenated format), pagination, filtering, and relationship serialization out of the box.
You integrate it by adding it to INSTALLED_APPS, configuring DRF's REST_FRAMEWORK settings to use its parsers and renderers, and then your existing class-based views automatically produce JSON:API responses. It aims to stay compatible with DRF's design philosophy rather than working around it, and supports the current Django and Python release lines with sane defaults that require minimal configuration for basic use.
Use it for
- Building a REST API that must comply with the JSON:API specification for client-side framework compatibility.
- Converting an existing Django REST framework API to JSON:API format without rewriting view logic.
- Implementing standardized pagination, filtering, and relationship links across a Django API.
- Creating APIs consumed by JavaScript frameworks (Ember, Vue, React) that have JSON:API client libraries.
- Handling complex nested data and relationships in a spec-compliant way with automatic serialization.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
If you are building a Django REST framework API and need or want JSON:API compliance, this is the standard adapter for that job. It has low install friction, active maintenance, no known vulnerabilities, and a permissive license. It integrates cleanly with DRF's existing patterns and is well-established (since 2015). Install it if JSON:API format is a requirement or a deliberate choice for your API design.
Install
djangorestframework-jsonapi on PyPI
Before you install
Low friction install with three straightforward runtime dependencies (django, djangorestframework, inflection). Actively maintained with recent commits and no known vulnerabilities. Supports current Python versions (3.9–3.14) and recent Django/DRF releases.
Requires Django 4.2+ and Django REST framework 3.15+; Python 3.9 or later.
License in practice
BSD permissive license allows use in commercial and private projects with minimal restrictions—typical for web framework extensions.
Quickstart
pip install djangorestframework-jsonapi
# In settings.py, add to INSTALLED_APPS after rest_framework:
INSTALLED_APPS = [
'rest_framework',
'rest_framework_json_api',
]
# Configure REST_FRAMEWORK to use JSON:API renderers and parsers:
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': (
'rest_framework_json_api.renderers.JSONRenderer',
),
'DEFAULT_PARSER_CLASSES': (
'rest_framework_json_api.parsers.JSONParser',
),
}Verify before relying
- Whether optional integrations (django-filter, django-polymorphic) are tested against all supported versions or only the latest.
- Performance characteristics when handling large result sets or deeply nested relationships.
Package facts
| License | BSD permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesinflectiondjangorestframeworkdjango |
| Maintenance | Actively maintained 301 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 368,208 / month, #7,190 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: Web EnvironmentFramework :: DjangoIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.9Topic :: Internet :: WWW/HTTPTopic :: Software Development :: Libraries :: Application FrameworksTopic :: Software Development :: Libraries :: Python Modules |
Evidence: djangorestframework_jsonapi-8.1.0-py2.py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “json:api django rest framework”
- djangorestframework-jsonapiAdapts Django REST framework to output responses in JSON:API…
- drf-jwtAdds JSON Web Token (JWT) authentication to Django REST Framework…
- djangorestframework-jwtAdds JSON Web Token (JWT) authentication support to Django REST…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also djangorestframework · djangorestframework-datatables · marshmallow-jsonapi · djangorestframework-filters · drf-spectacular-jsonapi · drf-dynamic-fields · djangorestframework-yaml · djangorestframework-xml · django-rest-polymorphic · apimatic-core