drf-spectacular-jsonapi

open api 3 schema generator for drf-json-api package based on drf-spectacular package.

Tested with various dependency version

Tested for versions in combination:
python	django	drf-spectacular
3.10	4.0	0.25.x
3.11	4.1	0.26.x
3.12	4.2	0.27.x
3.13	5.0	0.28.x
3.14	5.1	0.29.x
	5.2
	6.0

Installation

Install using pip…

$ pip install drf-spectacular-jsonapi

then configure the rest framework and drf-spectacular with the following settings inside your project settings.py

REST_FRAMEWORK = {
    # YOUR SETTINGS
    "DEFAULT_SCHEMA_CLASS": "drf_spectacular_jsonapi.schemas.openapi.JsonApiAutoSchema",
    "DEFAULT_PAGINATION_CLASS": "drf_spectacular_jsonapi.schemas.pagination.JsonApiPageNumberPagination",
}
SPECTACULAR_SETTINGS = {
    # To provide different schema components for patch and post
    "COMPONENT_SPLIT_REQUEST": True
    # to fix path parameter names for nested routes https://chibisov.github.io/drf-extensions/docs/#nested-routes
    "PREPROCESSING_HOOKS": [
        "drf_spectacular_jsonapi.hooks.fix_nested_path_parameters"
    ],
}

Release management

Same as the based drf-spectacular package, we provide versions below sem version 1.x.x to signal that every new version may potentially break you.

Metadata

Release files for drf-spectacular-jsonapi 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for drf-spectacular-jsonapi 0.6.1
File	Size	Uploaded
drf_spectacular_jsonapi-0.6.1.tar.gz	19.6 kB	Aug 31, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for drf-spectacular-jsonapi 0.6.1
File	Interpreter	ABI	Platform	Reset
drf_spectacular_jsonapi-0.6.1-py3-none-any.whl 16.0 kB Aug 31, 2026	Python 3	none	any	Details

Total release size: 35.7 kB

Release files / drf_spectacular_jsonapi-0.6.1.tar.gz

Download URL	drf_spectacular_jsonapi-0.6.1.tar.gz
Size	19.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`e836fd0e47d96522b54e95c6540a851f16ea36d6234ed1a11ee6d95209c1f371`
BLAKE2b-256 checksum How to use checksums	`1da3a1c5d327584a7ef183c368baee1b334897979b6e6c3f21040f25baa2c99b`
Upload date	Aug 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / drf_spectacular_jsonapi-0.6.1-py3-none-any.whl

Download URL	drf_spectacular_jsonapi-0.6.1-py3-none-any.whl
Size	16.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`474286403ecf6b50ece99f7768102971416da95e369327e58dbc7ef9a03b98b3`
BLAKE2b-256 checksum How to use checksums	`20a0f2dca173454a8c21d23b6d032e7ae0de9ff4e40d549150e861aeaa9de011`
Upload date	Aug 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`