Enable new scripts config in Swagger UI

Signed-off-by: Phillip Kruger <phillip.kruger@gmail.com> (cherry picked from commit 20fe535)
quarkusio · Jan 21, 2025 · cf9a219 · cf9a219
1 parent 3fcba30
commit cf9a219
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiConfig.java b/.../swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiConfig.java
@@ -256,6 +256,12 @@ public class SwaggerUiConfig {
     @ConfigItem
     Optional<List<String>> plugins;
 
+    /**
+     * A list of external scripts (usually plugins) to use in Swagger UI.
+     */
+    @ConfigItem
+    Optional<List<String>> scripts;
+
     /**
      * A list of presets to use in Swagger UI.
      */

diff --git a/...agger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java b/...agger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java
@@ -347,6 +347,11 @@ private byte[] generateIndexHtml(String openApiPath, String swaggerUiPath, Swagg
             options.put(Option.plugins, plugins);
         }
 
+        if (swaggerUiConfig.scripts.isPresent()) {
+            String scripts = String.join(",", swaggerUiConfig.scripts.get());
+            options.put(Option.scripts, scripts);
+        }
+
         if (swaggerUiConfig.presets.isPresent()) {
             String presets = swaggerUiConfig.presets.get().toString();
             options.put(Option.presets, presets);

diff --git a/...agger-ui/deployment/src/test/java/io/quarkus/swaggerui/deployment/SwaggerOptionsTest.java b/...agger-ui/deployment/src/test/java/io/quarkus/swaggerui/deployment/SwaggerOptionsTest.java
@@ -22,7 +22,7 @@ public class SwaggerOptionsTest {
 
     @Test
     public void customOptions() {
-        RestAssured.when().get("/q/swagger-ui").then().statusCode(200)
+        RestAssured.when().get("/q/swagger-ui").then().log().all().and().statusCode(200)
                 .body(
                         containsString("Testing title"),
                         containsString("/openapi"),
@@ -33,7 +33,9 @@ public void customOptions() {
                         containsString("validatorUrl: 'localhost'"),
                         containsString("displayRequestDuration: true"),
                         containsString("supportedSubmitMethods: ['get', 'post']"),
-                        containsString("plugins: [Plugin1, Plugin2]"));
+                        containsString("plugins: [Plugin1, Plugin2]"),
+                        containsString("https://unpkg.com/swagger-ui-plugin-hierarchical-tags"),
+                        containsString("/some/local/script.js"));
 
     }
 
@@ -61,5 +63,7 @@ private static String getPropertyAsString() {
         PROPERTIES.put("quarkus.swagger-ui.display-request-duration", "true");
         PROPERTIES.put("quarkus.swagger-ui.supported-submit-methods", "get,post");
         PROPERTIES.put("quarkus.swagger-ui.plugins", "Plugin1,Plugin2");
+        PROPERTIES.put("quarkus.swagger-ui.scripts",
+                "https://unpkg.com/swagger-ui-plugin-hierarchical-tags,/some/local/script.js");
     }
 }