lock8/django-rest-swagger

Swagger Documentation Generator for Django REST Framework

Django REST Swagger

####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.

Installation

1. pip install django-rest-swagger

2. Add rest_framework_swagger to your INSTALLED_APPS setting:

       INSTALLED_APPS = (
           ...
           'rest_framework_swagger',
       )

Rendering Swagger Specification and Documentation

This package ships with two renderer classes:

1. 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

2. SwaggerUIRenderer generates the Swagger UI and requires the OpenAPIRenderer

Example: DRF Schema View

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))

Requirements

• Django 1.8+
• Django REST framework 3.4+
• Python 2.7, 3.5

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