Merge pull request #163 from Nix41/master

Allow Swagger-UI configuration through settings Closes #162 and Closes #160
tfranzel · Oct 10, 2020 · 86dd8f7 · 86dd8f7
2 parents da66def + 8823bb0
commit 86dd8f7
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/drf_spectacular/settings.py b/drf_spectacular/settings.py
@@ -28,6 +28,10 @@
     'SERVE_INCLUDE_SCHEMA': True,
     'SERVE_PERMISSIONS': ['rest_framework.permissions.AllowAny'],
 
+    # Dictionary of configurations to pass to the SwaggerUI({ ... })
+    # https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
+    'SWAGGER_UI_SETTINGS': {},
+
     # Append OpenAPI objects to path and components in addition to the generated objects
     'APPEND_PATHS': {},
     'APPEND_COMPONENTS': {},

diff --git a/drf_spectacular/templates/drf_spectacular/swagger_ui.html b/drf_spectacular/templates/drf_spectacular/swagger_ui.html
@@ -10,6 +10,7 @@
     <div id="swagger-ui"></div>
     <script src="//unpkg.com/swagger-ui-dist@3.35.0/swagger-ui-bundle.js"></script>
     <script>
+    var swagger_settings  = {{ settings|safe }}
     const ui = SwaggerUIBundle({
         url: "{{ schema_url }}",
         dom_id: '#swagger-ui',
@@ -22,7 +23,8 @@
         requestInterceptor: (request) => {
           request.headers['X-CSRFToken'] = "{{ csrf_token }}"
           return request;
-        }
+        },
+        ...swagger_settings
       })
     </script>
   </body>

diff --git a/drf_spectacular/views.py b/drf_spectacular/views.py
@@ -1,3 +1,4 @@
+import json
 from collections import namedtuple
 from typing import Any, Dict
 
@@ -83,8 +84,9 @@ def get(self, request, *args, **kwargs):
         schema_url = self.url or reverse(self.url_name, request=request)
         if request.GET.get('lang'):
             schema_url += f'{"&" if "?" in schema_url else "?"}lang={request.GET.get("lang")}'
+        settings = json.dumps(spectacular_settings.SWAGGER_UI_SETTINGS)
         return Response(
-            {'schema_url': schema_url},
+            {'schema_url': schema_url, 'settings': settings},
             template_name=self.template_name
         )