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.2

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.2
File	Size	Uploaded
drf_spectacular_jsonapi-0.6.2.tar.gz	19.7 kB	Aug 31, 2026	Details

Built distribution (wheel)

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

Total release size: 35.8 kB

Release files / drf_spectacular_jsonapi-0.6.2.tar.gz

Download URL	drf_spectacular_jsonapi-0.6.2.tar.gz
Size	19.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`cfa59aa42b562886e5ee8434295d2e7fc6fbfd3291ebaecdff1d60ae0442ab9d`
BLAKE2b-256 checksum How to use checksums	`f711e9938a80dd869c1d52d905c1ebe71931bf03dcd7716765ff8d318152eb8d`
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.2-py3-none-any.whl

Download URL	drf_spectacular_jsonapi-0.6.2-py3-none-any.whl
Size	16.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8f8e0fbbf7406d075307aa58be767755734cd267ce3e20946d69be840b8d5f64`
BLAKE2b-256 checksum How to use checksums	`4729edef910cf60f866d0ebda9c2d40a8c0941b2e244348c62cae3b31faf561c`
Upload date	Aug 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`