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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cd4bec18a0a191e5f17d583f6ff02e2477ecc2e1bc91e7d3d291c88fd778668 |
|
MD5 | e408ac19eaad494232d46a09b81684db |
|
BLAKE2b-256 | 097c0b9e10fc1209d0327e51cbc4445601cbd003b4bce94426ad52fc241a8c91 |
Close
Hashes for drf_spectacular_jsonapi-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c811f2c793cca38a049dac5a994b35138b95b87dc5a76dc164deb96a3b7e9503 |
|
MD5 | 44b3a649127c9cf3997839ee677100a2 |
|
BLAKE2b-256 | e6f3430f116038d774ae122e8cba5fbe4824fca2dae502b318284f9a5fb84eb3 |