Skip to main content

Django REST Framework extras for better Swagger/OpenAPI self-documentation

Project description

drf-swagger-extras

Build Status Coverage Report Requirements Status

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.

Project details


Release history Release notifications

This version
History Node

0.1.0.dev1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
drf_swagger_extras-0.1.0.dev1-py2.py3-none-any.whl (8.1 kB) Copy SHA256 hash SHA256 Wheel any Sep 20, 2016
drf-swagger-extras-0.1.0.dev1.tar.gz (6.0 kB) Copy SHA256 hash SHA256 Source None Sep 20, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page