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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6fad4f28ecd7208696150b4360690cfc1cd394966d63ebb1b3a0ce23b0a5dee |
|
MD5 | a9e3e7cd263b02a2a8a8449176830b07 |
|
BLAKE2b-256 | 27267d33ab0f6bc7c66f4e4c091318925f1daae266c7f69fd0f3d21f4083824b |
Close
Hashes for drf_spectacular_jsonapi-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa9cb580629eb001b7a2dcee95d138434db56adde5d0f380736fd8f4d09f5835 |
|
MD5 | 128688eb5c587de491aa175d6d0612a0 |
|
BLAKE2b-256 | 251b6fbeaaed0d3ae63419aacc64db1ead968c11e8f2a658c23b5f86df55c9f6 |