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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcd076598651ff48417d1a25d704374aae03480842c459506eb74d2de5677b10 |
|
MD5 | 1a8b4eadf45c8409cfc2fb4336a02f66 |
|
BLAKE2b-256 | a0fcae65fb905ae07e822b004eb93f498e0ce1c36ab9c918428d954cb1ee641a |
Close
Hashes for drf_spectacular_jsonapi-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c7a64966f26041766967774c88a56c76c4d7cb9cd4881b2ae85b0745fff880e |
|
MD5 | 7a887c21b625f56ee6ca0ce69432457d |
|
BLAKE2b-256 | b25f55e589c85de0ec3e5ccd1bae193125e446c4b905f373e2b8c1fdeb50ac2a |