drf-spectacular-sidecar

======================= drf-spectacular-sidecar

|pypi-version| |pypi-dl|

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 <https://www.npmjs.com/package/swagger-ui-dist>__)
• Redoc_ version 2.2.0 (npm <https://www.npmjs.com/package/redoc>__)

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

.. code:: bash

$ pip install drf-spectacular-sidecar

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

.. code:: python

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

Requirements

Django >= 2.2

Licenses

Provided by T. Franzel <https://github.com/tfranzel>. Licensed under 3-Clause BSD <https://github.com/tfranzel/drf-spectacular-sidecar/blob/master/LICENSE>.

This package includes distribution builds of

• Swagger UI: The original license (Apache 2.0) <https://github.com/swagger-api/swagger-ui/blob/master/LICENSE> and copyright apply to those files.
• Redoc: The original license (MIT) <https://github.com/Redocly/redoc/blob/master/LICENSE> and copyright apply to those files.

.. |pypi-version| image:: https://img.shields.io/pypi/v/drf-spectacular-sidecar.svg :target: https://pypi.org/project/drf-spectacular-sidecar/ .. |pypi-dl| image:: https://img.shields.io/pypi/dm/drf-spectacular-sidecar :target: https://pypi.org/project/drf-spectacular-sidecar/

.. _PyPI: https://pypi.org/project/drf-spectacular-sidecar/ .. _jsdelivr: https://www.jsdelivr.com/ .. _Django: https://www.djangoproject.com/ .. _drf-spectacular: https://github.com/tfranzel/drf-spectacular .. _Redoc: https://github.com/Redocly/redoc .. _Swagger UI: https://github.com/swagger-api/swagger-ui .. _collectstatic: https://docs.djangoproject.com/en/3.2/ref/contrib/staticfiles/#collectstatic .. _runserver: https://docs.djangoproject.com/en/3.2/ref/contrib/staticfiles/#runserver