Django REST Framework extras for better Swagger/OpenAPI self-documentation
Project description
drf-swagger-extras
This package provides OpenAPI documentation Python decorators for Django REST Framework APIViews.
This module provides a patched SchemaGenerator that enhances current CoreAPI-based data that is grabbed by REST Framework with documentation provided by decorators found in this package.
We allow documenting different response types and formats, and each HTTP status code along with a schema and examples of the expected outcome.
We also provide optional API comments based on the function’s docstrings.
Usage
~ to be filled ~
Contributing
This project uses the GitHub Flow approach for contributing, meaning that we would really appreciate it if you would send patches as Pull Requests in GitHub. If for any reason you prefer to send patches by email, they are also welcome and will end up integrated here.
License
This code is released under a MIT License.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file drf-swagger-extras-0.1.0.dev1.tar.gz.
File metadata
- Download URL: drf-swagger-extras-0.1.0.dev1.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e5cfbc733a04bbedbf20fd98bb46e51549eeb035a92a965ddd6b2d956c986ded
|
|
| MD5 |
ce971a7526302e88f35621864cae4313
|
|
| BLAKE2b-256 |
99d398ebf34b52ebc97bc59cb2d4ce105e534f71c6af5f3c63f2ecc2242a4191
|
File details
Details for the file drf_swagger_extras-0.1.0.dev1-py2.py3-none-any.whl.
File metadata
- Download URL: drf_swagger_extras-0.1.0.dev1-py2.py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
353843caac3f061d1493245edf0e7fc5d40c8f8dea2dec4de0821da5dd8b3d34
|
|
| MD5 |
16c34182f5987425a1431c8f1b48a555
|
|
| BLAKE2b-256 |
9901a80586f1e52330c6ce63f01579f7794b3ff7771a0071b856def19ec7a5c4
|
