Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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 History

This version
History Node

0.1.0.dev1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
drf_swagger_extras-0.1.0.dev1-py2.py3-none-any.whl (8.1 kB) Copy SHA256 Checksum SHA256 any Wheel Sep 20, 2016
drf-swagger-extras-0.1.0.dev1.tar.gz (6.0 kB) Copy SHA256 Checksum SHA256 Source Sep 20, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting