Skip to main content

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

Project description


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.


~ to be filled ~


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.


This code is released under a MIT License.

Project details

Download files

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

Source Distribution

drf-swagger-extras-0.1.0.dev1.tar.gz (6.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page