README.rst

drf-spectacular-sidecar

Serve self-contained distribution builds of Swagger UI and Redoc with Django either via runserver or collectstatic.

This Django app is an optional addition to drf-spectacular, but does not depend on it. It may also be used independently.

• Swagger UI version 5.18.2 (npm)
• Redoc version 2.2.0 (npm)

This is a self-updating and self-publishing repository that looks for updates on the 1st of every month. The distribution files are sourced from npm via jsdelivr, validated, packaged and uploaded to PyPI.

Installation

$ pip install drf-spectacular-sidecar

The package needs to be registered to allow Django to discover the static files.

INSTALLED_APPS = [
    # ALL YOUR APPS
    'drf_spectacular_sidecar',
]

Requirements

Django >= 2.2

Licenses

Provided by T. Franzel. Licensed under 3-Clause BSD.

This package includes distribution builds of

• Swagger UI: The original license (Apache 2.0) and copyright apply to those files.
• Redoc: The original license (MIT) and copyright apply to those files.