12148 add swagger-sidecar for self-hosted swagger docs (#12159)

* 12148 add swagger-sidecar for self-hosted swagger docs

* 12149 add to base_requirements

base_requirements.txt

@@ -70,6 +70,10 @@ djangorestframework
 # https://github.com/tfranzel/drf-spectacular
 drf-spectacular
 
+# Serve self-contained distribution builds of Swagger UI and Redoc with Django.
+# https://github.com/tfranzel/drf-spectacular-sidecar
+drf-spectacular-sidecar
+
 # RSS feed parser
 # https://github.com/kurtmckee/feedparser
 feedparser

netbox/netbox/settings.py

@@ -345,6 +345,7 @@ INSTALLED_APPS = [
     'wireless',
     'django_rq',  # Must come after extras to allow overriding management commands
     'drf_spectacular',
+    'drf_spectacular_sidecar',
 ]
 
 # Middleware
@@ -584,6 +585,9 @@ SPECTACULAR_SETTINGS = {
     "LICENSE": {"name": "Apache v2 License"},
     "VERSION": VERSION,
     'COMPONENT_SPLIT_REQUEST': True,
+    'SWAGGER_UI_DIST': 'SIDECAR',
+    'SWAGGER_UI_FAVICON_HREF': 'SIDECAR',
+    'REDOC_DIST': 'SIDECAR',
 }
 
 #

requirements.txt

@@ -15,7 +15,8 @@ django-tables2==2.5.3
 django-taggit==3.1.0
 django-timezone-field==5.0
 djangorestframework==3.14.0
-drf-spectacular==0.25.1
+drf-spectacular==0.26.1
+drf-spectacular-sidecar==2023.4.1
 feedparser==6.0.10
 graphene-django==3.0.0
 gunicorn==20.1.0