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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc0fbf92db7ebcbbf152b098875b6f31b7a70c443207ebfd14874e0843d34dc1 |
|
MD5 | 0d386a47c1a706555961fd74c468a316 |
|
BLAKE2b-256 | a4c91c44d1a61f0db791f091d89f0bfc954a91e5414e07ca279b17a40c066e0d |
Close
Hashes for drf_spectacular_jsonapi-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e40fddda1569fe1063102401a4836d54d01e08f969a82fbde66230e2edc2578 |
|
MD5 | 4b5372119e7278345734aa0312be2634 |
|
BLAKE2b-256 | 2a65e64a965b79b1e1e3b41a8f59a8dddd5729ac8d9d389c057006f55c9bab5e |