Django REST Swagger: deprecated (2019-06-04)
This project is no longer being maintained. Please consider drf-yasg as an alternative/successor. I haven't personally used it, but it looks feature-complete and is actively maintained.
https://github.com/axnsan12/drf-yasg
Thanks for all the support and contributions over the years. Special thanks to Lights on Software, Lincoln Loop and BNOTIONS for generously donating time to work on this project :heart:.
An API documentation generator for Swagger UI and Django REST Framework
Full documentation: http://marcgibbons.github.io/django-rest-swagger/
Installation
-
pip install django-rest-swagger -
Add
rest_framework_swaggerto yourINSTALLED_APPSsetting:INSTALLED_APPS = ( ... 'rest_framework_swagger', )
Rendering Swagger Specification and Documentation
This package ships with two renderer classes:
OpenAPIRenderergenerates the OpenAPI (fka Swagger) JSON schema specification. This renderer will be presented if:
Content-Type: application/openapi+jsonis specified in the headers.?format=openapiis passed as query param
SwaggerUIRenderergenerates the Swagger UI and requires theOpenAPIRenderer
Quick Start Example:
from django.conf.urls import url
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='Pastebin API')
urlpatterns = [
url(r'^$', schema_view)
]
Requirements
- Django 1.8+
- Django REST framework 3.5.1+
- Python 2.7, 3.5, 3.6
Testing
- Run
$ toxto execute the test suite against all supported environments. - Run
./runtests.pyto run the test suite within the current environment.
Bugs & Contributions
Please report bugs by opening an issue
Contributions are welcome and are encouraged!
Special Thanks
Many thanks to Tom Christie & all the contributors who have developed Django REST Framework