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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b7971475fca3b22c2dc75b2c9de582decd20659a7a918ff5c7ed33031ab04e7 |
|
MD5 | b961fd896ce1adf38f26bb2b30f62d40 |
|
BLAKE2b-256 | cb23499027ac4a5cfc62c47e2f9bb89db6146d6911bc4f889df306b6f402a502 |
Close
Hashes for drf_spectacular_jsonapi-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a15c2d9feb45cead6f921e7c381ee90dbfdad5ed1205e870b90a2401ea911b4a |
|
MD5 | 81585f7ec2b9275a76cc5430d4d0b54d |
|
BLAKE2b-256 | 03c84b5608974a61eabbda8e42c73f11bbe890d5ebd1412907200358983db1e7 |