drf-spectacular-json-api
open api 3 schema generator for drf-json-api package based on drf-spectacular package.
Tested with various dependency version
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.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| drf_spectacular_jsonapi-0.7.0.tar.gz | 27.1 kB | Without provenance | Details for drf_spectacular_jsonapi-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| drf_spectacular_jsonapi-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for drf_spectacular_jsonapi-0.7.0-py3-none-any.whl |
Total release size: 46.0 kB
Release files / drf_spectacular_jsonapi-0.7.0.tar.gz
| Download URL | drf_spectacular_jsonapi-0.7.0.tar.gz |
|---|---|
| Size | 27.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
185ce078fe47a80f8f3158fd8bb6867a1d589222898b96c44a6b6252bd2b2a7c
|
|
BLAKE2b-256 checksum How to use checksums |
c34484040f0c4eda5d4d1239a6cdb7680632a67079e293e7bb79759d6f79dbcb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / drf_spectacular_jsonapi-0.7.0-py3-none-any.whl
| Download URL | drf_spectacular_jsonapi-0.7.0-py3-none-any.whl |
|---|---|
| Size | 19.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1c347d90aca53177b482a4e8d0b4e27427696c642699b91947a41e34c8e7add3
|
|
BLAKE2b-256 checksum How to use checksums |
73c4f450878acfff1376c0cc0679f84a821db4e64d15bf188405957fd31b1d29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for drf-spectacular-jsonapi 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.