Django REST Swagger

2.2.0 · deprecated · verified Wed Apr 15

django-rest-swagger provides Swagger UI integration for Django REST Framework (DRF) 3.5+. The project is currently at version 2.2.0, released in 2017, and is in maintenance mode. New projects are strongly advised to use modern alternatives like drf-yasg or drf-spectacular for OpenAPI/Swagger documentation.

Warnings

deprecated The `django-rest-swagger` library is deprecated and is in maintenance mode, receiving only critical bug fixes. It's built against older DRF versions and Swagger UI v3.13.6, making it unsuitable for modern projects.
Fix: For new projects or existing projects needing active development/modern features, migrate to `drf-yasg` or `drf-spectacular` which provide OpenAPI 3.0+ support and are actively maintained.
breaking Version 2.0.0 introduced significant breaking changes, shifting from introspection/YAML overrides to CoreAPI and renderer classes for schema generation, and requiring Django REST Framework 3.4+.
Fix: Review the 2.0.0 release notes for `django-rest-swagger` and update code to use CoreAPI schema generation and renderer classes. Ensure `djangorestframework` is at least 3.4.
breaking Version 2.1.0 increased the minimum required Django REST Framework version to 3.5.1.
Fix: Upgrade `djangorestframework` to at least 3.5.1 to ensure compatibility with `django-rest-swagger` 2.1.0 and later.
gotcha Authentication support, especially for non-session APIs (e.g., Token or JWT authentication), might be limited or require custom workarounds due to the older Swagger UI version and bootstrap client architecture.
Fix: Consult the `django-rest-swagger` GitHub issues for community-contributed workarounds or consider migrating to more actively developed alternatives with better, out-of-the-box authentication support.

Install

pip install django-rest-swagger Install latest version

Imports

get_swagger_view

from rest_framework_swagger.views import get_swagger_view

Quickstart

Add 'rest_framework_swagger' to INSTALLED_APPS in settings.py and include the swagger URL pattern in your project's urls.py. The get_swagger_view function creates a view for the Swagger UI.

# settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
    'rest_framework_swagger',
]

# urls.py
from django.urls import re_path
from rest_framework_swagger.views import get_swagger_view

# Replace 'My API' with your project's title
schema_view = get_swagger_view(title='My API')

urlpatterns = [
    # ... other url patterns
    re_path(r'^swagger/$', schema_view)
]

view raw JSON →