drf-spectacular-jsonapi
open api 3 schema generator for drf-json-api package based on drf-spectacular package.
Decision gist · record as of 2026-08-14
Yes, if you are already using djangorestframework-jsonapi and drf-spectacular together. It solves a real gap—standard schema generators don't understand JSON:API semantics—and has low install friction. The alpha status and small community (14 stars) mean you should expect occasional breaking changes and limited third-party troubleshooting resources, but the package is actively maintained and has no known vulnerabilities.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Django, djangorestframework, djangorestframework-jsonapi, and drf-spectacular to be installed and configured first.
- Low friction install with a pure-Python wheel.
- Actively maintained as of May 2026 with recent releases.
License · maintenance · safety
BSD (permissive) — BSD license is permissive, allowing commercial and private use with minimal restrictions. You may use, modify, and distribute this package freely as long as you include the license notice.
last release 2026-05-19 (87 days) · last repo commit 2026-05-19 · 14 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 94,920 downloads/mo, #13,297 on PyPI
Alternatives
Verify before relying
pip install drf-spectacular-jsonapi
# In settings.py:
REST_FRAMEWORK = {
"DEFAULT_SCHEMA_CLASS": "drf_spectacular_jsonapi.schemas.openapi.JsonApiAutoSchema",
}
SPECTACULAR_SETTINGS = {
"COMPONENT_SPLIT_REQUEST": True,
}- Whether the package works correctly with Django 5.2 and 6.0 (listed in test matrix but without explicit Python/drf-spectacular versions)
- Current state of the 14 GitHub stars and whether the package has active community adoption beyond download counts
What it is and what it does
This package bridges drf-spectacular (a popular OpenAPI schema generator for Django REST Framework) and djangorestframework-jsonapi (which implements the JSON:API specification). It generates OpenAPI 3 schemas that correctly represent JSON:API-compliant endpoints, handling JSON:API-specific conventions like sparse fieldsets, includes, and filtering that standard schema generators don't understand.
You install it alongside your existing Django REST Framework setup, configure it as the schema class in your REST_FRAMEWORK settings, and it automatically generates accurate OpenAPI documentation for your JSON:API endpoints. It includes hooks for handling nested routes from drf-extensions and can split request schemas for PATCH and POST operations. The package is in alpha (pre-1.0) and signals that breaking changes may occur in minor version bumps.
Use it for
- Generate interactive OpenAPI documentation (Swagger/ReDoc) for JSON:API endpoints without manual schema annotation.
- Integrate JSON:API services with API client generators that consume OpenAPI specs.
- Document nested resource routes created with drf-extensions in a way that reflects their JSON:API structure.
- Split request/response schemas for PATCH and POST operations to show different required fields per HTTP method.
- Validate that your JSON:API implementation conforms to the spec by inspecting the generated schema.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are already using djangorestframework-jsonapi and drf-spectacular together.
It solves a real gap—standard schema generators don't understand JSON:API semantics—and has low install friction. The alpha status and small community (14 stars) mean you should expect occasional breaking changes and limited third-party troubleshooting resources, but the package is actively maintained and has no known vulnerabilities.
Install
drf-spectacular-jsonapi on PyPI
Before you install
Low friction install with a pure-Python wheel. Actively maintained as of May 2026 with recent releases. Depends on five runtime packages (Django, drf-spectacular, drf-extensions, djangorestframework, djangorestframework-jsonapi) that you must already have configured; the documentation explicitly requires installing those first.
Requires Django, djangorestframework, djangorestframework-jsonapi, and drf-spectacular to be installed and configured first.
License in practice
BSD license is permissive, allowing commercial and private use with minimal restrictions. You may use, modify, and distribute this package freely as long as you include the license notice.
Quickstart
pip install drf-spectacular-jsonapi
# In settings.py:
REST_FRAMEWORK = {
"DEFAULT_SCHEMA_CLASS": "drf_spectacular_jsonapi.schemas.openapi.JsonApiAutoSchema",
}
SPECTACULAR_SETTINGS = {
"COMPONENT_SPLIT_REQUEST": True,
}Verify before relying
- Whether the package works correctly with Django 5.2 and 6.0 (listed in test matrix but without explicit Python/drf-spectacular versions)
- Current state of the 14 GitHub stars and whether the package has active community adoption beyond download counts
Package facts
| License | BSD permissive |
| Python support | Supports the current Python release >=3.7 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 5 packagesDjangodrf-spectaculardrf-extensionsdjangorestframeworkdjangorestframework-jsonapi |
| Maintenance | Actively maintained 87 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 94,920 / month, #13,297 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 3 - AlphaEnvironment :: Web EnvironmentFramework :: DjangoIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Internet :: WWW/HTTPTopic :: Software Development :: Code GeneratorsTopic :: Software Development :: Libraries |
Evidence: drf_spectacular_jsonapi-0.6.0-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 › “openapi schema generator json api”
- drf-spectacular-jsonapiGenerates OpenAPI 3 schemas for Django REST Framework APIs that use…
- essentials-openapiGenerates OpenAPI v2 and v3 documentation in JSON and YAML formats,…
- apispecGenerates OpenAPI specification documents from Python code,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Libraries packages
urllib3 is an HTTP client library that provides thread-safe connection pooling, SSL/TLS verification, multipart file uploads, request retries, compression support, and proxy handling for Python applications.
Requests is a Python HTTP library that simplifies sending HTTP/1.1 requests with automatic handling of headers, authentication, cookies, and response parsing.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Provides parsing, arithmetic, and recurrence rule computation for dates and times, with timezone support and iCalendar RFC compliance.
Install it if you need to parse flexible date strings, compute relative dates, handle timezones, or work with recurrence rules—it's the de facto choice for these tasks.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
pytest is a testing framework that lets you write test functions using plain assert statements and automatically discovers and runs them, with detailed failure reporting.
See also drf-spectacular · djangorestframework-jsonapi · drf-spectacular-sidecar · drf-standardized-errors · drf-extensions · drf-yasg · djangorestframework · drf-orjson-renderer · voluptuous-openapi · apispec