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.
An API documentation generator for Swagger UI and Django REST Framework
Full documentation: http://marcgibbons.github.io/django-rest-swagger/
pip install django-rest-swagger
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 the
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) ]
- Django 1.8+
- Django REST framework 3.5.1+
- Python 2.7, 3.5, 3.6
$ toxto execute the test suite against all supported environments.
./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!
Many thanks to Tom Christie & all the contributors who have developed Django REST Framework