{"id":6599,"library":"django-rest-swagger","title":"Django REST Swagger","description":"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.","status":"deprecated","version":"2.2.0","language":"en","source_language":"en","source_url":"https://github.com/marcgibbons/django-rest-swagger","tags":["django","rest","swagger","openapi","api-documentation","deprecated"],"install":[{"cmd":"pip install django-rest-swagger","lang":"bash","label":"Install latest version"}],"dependencies":[{"reason":"Required for core functionality; minimum version 3.5.1","package":"djangorestframework","optional":false},{"reason":"Required for Django projects; minimum version not explicitly stated but compatible with DRF 3.5.1 generally means Django 1.8-2.x.","package":"Django","optional":false}],"imports":[{"symbol":"get_swagger_view","correct":"from rest_framework_swagger.views import get_swagger_view"}],"quickstart":{"code":"# settings.py\nINSTALLED_APPS = [\n    # ...\n    'rest_framework',\n    'rest_framework_swagger',\n]\n\n# urls.py\nfrom django.urls import re_path\nfrom rest_framework_swagger.views import get_swagger_view\n\n# Replace 'My API' with your project's title\nschema_view = get_swagger_view(title='My API')\n\nurlpatterns = [\n    # ... other url patterns\n    re_path(r'^swagger/$', schema_view)\n]","lang":"python","description":"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."},"warnings":[{"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.","message":"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.","severity":"deprecated","affected_versions":"2.x and earlier"},{"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.","message":"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+.","severity":"breaking","affected_versions":"Before 2.0.0 to 2.0.0+"},{"fix":"Upgrade `djangorestframework` to at least 3.5.1 to ensure compatibility with `django-rest-swagger` 2.1.0 and later.","message":"Version 2.1.0 increased the minimum required Django REST Framework version to 3.5.1.","severity":"breaking","affected_versions":"Before 2.1.0 to 2.1.0+"},{"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.","message":"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.","severity":"gotcha","affected_versions":"2.x"}],"env_vars":null,"last_verified":"2026-04-15T00:00:00.000Z","next_check":"2026-07-14T00:00:00.000Z","problems":[]}