django-rest-swagger

What it is and what it does

Django REST Swagger generates interactive API documentation for Django REST Framework projects by rendering Swagger UI and OpenAPI JSON schemas. It integrates directly into your Django URL configuration and automatically documents your REST endpoints, allowing developers to explore and test your API through a browser-based interface.

The package is officially deprecated as of 2019 and is no longer maintained. Its repository is archived, meaning no bug fixes, security patches, or compatibility updates will be released. The maintainer explicitly recommends an alternative. Installing this package today means accepting technical debt and potential incompatibility with modern Django and Python versions.

Use it for:

• Documenting legacy Django REST Framework APIs that are locked to older Django and Python versions
• Quick prototyping of REST APIs when you need Swagger UI without setting up a separate documentation tool
• Generating OpenAPI schemas for existing REST endpoints to expose to API consumers
• Testing REST endpoints interactively through the Swagger UI without writing client code

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Generates Swagger UI documentation and OpenAPI JSON schemas for Django REST Framework APIs, rendering interactive API documentation directly from your REST endpoints.

No. The package is abandoned and unmaintained since 2018, with no security or compatibility updates forthcoming. Its dependencies may become incompatible with modern Python and Django versions. The maintainer recommends using an alternative instead, unless you are locked into a legacy codebase that cannot be updated.

Install

django-rest-swagger on PyPI

pip install django-rest-swagger

uv add django-rest-swagger

poetry add django-rest-swagger

Installing django-rest-swagger

Before you install

Low install friction with four straightforward runtime dependencies. However, the project is abandoned as of 2019 and has not been maintained since April 2018 — the repository is archived and no security or compatibility updates will be released.

License in practice

Licensed under FreeBSD License (permissive), so you can use it freely in commercial and private projects with minimal restrictions.

Quickstart

pip install django-rest-swagger

from coreapi import Document
from openapi_codec import OpenAPICodec
from djangorestframework import serializers
from simplejson import dumps

Requires Django 1.8+, Django REST framework 3.5.1+, and Python 2.7 or 3.5–3.6; no longer compatible with modern Python or Django versions.

Verify before relying

• Compatibility with Django versions released after 2018 or Python 3.7+
• Whether the package's dependencies receive security updates
• Active community forks or maintained alternatives beyond what the maintainer recommends

Package facts

Evidence: django_rest_swagger-2.2.0-py2.py3-none-any.whl

Tags

More WWW/HTTP packages