drf-swagger-extras 0.1.0.dev1

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

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.