####An API documentation generator for Swagger UI and Django REST Framework
Full documentation: http://marcgibbons.github.io/django-rest-swagger/
Note: you are viewing documentation for version 2, using Django REST Framework 3.4+ and CoreAPI. Documentation for previous versions is available here.
-
pip install django-rest-swagger
-
Add
rest_framework_swagger
to yourINSTALLED_APPS
setting:INSTALLED_APPS = ( ... 'rest_framework_swagger', )
This package ships with two renderer classes:
OpenAPIRenderer
generates the OpenAPI (fka Swagger) JSON schema specification. This renderer will be presented if:
Content-Type: application/openapi+json
is specified in the headers.?format=openapi
is passed as query param
SwaggerUIRenderer
generates the Swagger UI and requires theOpenAPIRenderer
from rest_framework_swagger.renderers import OpenAPIRenderer, SwaggerUIRenderer
from rest_framework.decorators import api_view, renderer_classes
from rest_framework import response, schemas
@api_view()
@renderer_classes([SwaggerUIRenderer, OpenAPIRenderer])
def schema_view(request):
generator = schemas.SchemaGenerator(title='Pastebin API')
return response.Response(generator.get_schema(request=request))
- Django 1.8+
- Django REST framework 3.4+
- Python 2.7, 3.5
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