open api 3 schema generator for drf-json-api package based on drf-spectacular package.
Project description
open api 3 schema generator for drf-json-api package based on drf-spectacular package.
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
}
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for drf-spectacular-jsonapi-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a87ede973b90a881f389d19404436e767bac0f9bc6e1a74ba256d10798103a94 |
|
MD5 | f8c6e4795f324ffca07f26ab7d8671fe |
|
BLAKE2b-256 | 188c182570bf5715dbbdb69c836e3f2c4042e5179a665c220b5c77b61f8fe5ea |
Close
Hashes for drf_spectacular_jsonapi-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb16976c65a69d50d8b539fbf8648e0a1b3eae6e5d7bcce406d1f93131d77f98 |
|
MD5 | 00dd297d80c602f3c8091327ddbd5d74 |
|
BLAKE2b-256 | a056688a333e85f8902226b9297462aa16e81de572ce8cf0bc8f88b8da5ee8ed |