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.
Tested with various dependency version
python |
django |
drf-spectacular |
---|---|---|
3.8 |
4.0 |
0.25.x |
3.9 |
4.1 |
0.26.x |
3.10 |
4.2 |
0.27.x |
3.11 |
5.0 |
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
# to fix path parameter names for nested routes https://chibisov.github.io/drf-extensions/docs/#nested-routes
"PREPROCESSING_HOOKS": [
"drf_spectacular_jsonapi.hooks.fix_nested_path_parameters"
],
}
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.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e45f87f3cce2692f4f546e0785d8fcc32c6b49770fff858065c267ae8f9cfde5 |
|
MD5 | aaa5cae6845caba425d68e9deac35c04 |
|
BLAKE2b-256 | 71a7198704b65b5a0682ce5d4cc027113aa64faee33ba7f05e54a6e81013cfdf |
Close
Hashes for drf_spectacular_jsonapi-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | abac728abd83e2544408cc900d682d532ca2088f2f9321d1c9101bcdfdabca78 |
|
MD5 | 5dd1151cc71e9198dd310c4811c20d15 |
|
BLAKE2b-256 | 2190a2968757dac52d172ca48b0814c72513fc2e9653980b1a3df16b56ee3b8a |