https://github.com/tfranzel/drf-spectacular-sidecar

Serve self-contained distribution builds of Swagger UI and Redoc with Django.
https://github.com/tfranzel/drf-spectacular-sidecar

django drf openapi3 redoc swagger-ui

Last synced: 10 days ago
JSON representation

Serve self-contained distribution builds of Swagger UI and Redoc with Django.

• Host: GitHub
• URL: https://github.com/tfranzel/drf-spectacular-sidecar
• Owner: tfranzel
• License: bsd-3-clause
• Created: 2021-09-24T22:17:14.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-01T11:20:31.000Z (4 months ago)
• Last Synced: 2024-10-29T22:33:15.440Z (10 days ago)
• Topics: django, drf, openapi3, redoc, swagger-ui
• Language: Python
• Homepage:
• Size: 30.1 MB
• Stars: 32
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=======================

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.17.14`` (`npm `__)

* `Redoc`_ version ``2.1.5`` (`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

------------

.. 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 `_. `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.

.. |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