drf-spectacular-sidecar
Readme
|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.2 (npm <https://www.npmjs.com/package/swagger-ui-dist>__)Redoc_ version 2.1.4 (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.
.. 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',
]
Django >= 2.2
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
FAQs
Serve self-contained distribution builds of Swagger UI and Redoc with Django
We found that drf-spectacular-sidecar demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.