Enhance swagger-ui url, disable validation by default, post 1.6.0. Fixes

#1384
springdoc · Dec 16, 2021 · 5311835 · 5311835
1 parent 3e8227c
commit 5311835
Show file tree

Hide file tree

Showing 22 changed files with 43 additions and 22 deletions.
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/ui/AbstractSwaggerIndexTransformer.java b/springdoc-openapi-common/src/main/java/org/springdoc/ui/AbstractSwaggerIndexTransformer.java
@@ -171,7 +171,7 @@ protected String addParameters(String html) throws JsonProcessingException {
 				.filter(entry -> !SwaggerUiConfigParameters.OAUTH2_REDIRECT_URL_PROPERTY.equals(entry.getKey()))
 				.filter(entry -> !SwaggerUiConfigParameters.URL_PROPERTY.equals(entry.getKey()))
 				.filter(entry -> !SwaggerUiConfigParameters.URLS_PROPERTY.equals(entry.getKey()))
-				.filter(entry -> StringUtils.isNotEmpty((String) entry.getValue()))
+				.filter(entry -> SwaggerUiConfigParameters.VALIDATOR_URL_PROPERTY.equals(entry.getKey()) || StringUtils.isNotEmpty((String) entry.getValue()))
 				.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue,(e1, e2) -> e2,
 						LinkedHashMap::new));
 

diff --git a/springdoc-openapi-ui/src/test/resources/results/app1 b/springdoc-openapi-ui/src/test/resources/results/app1
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app1-contextpath b/springdoc-openapi-ui/src/test/resources/results/app1-contextpath
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/context-path/servlet-path/v3/api-docs/swagger-config"
+  "configUrl" : "/context-path/servlet-path/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app1-prefix b/springdoc-openapi-ui/src/test/resources/results/app1-prefix
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/documentation/v3/api-docs/swagger-config"
+  "configUrl" : "/documentation/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app10 b/springdoc-openapi-ui/src/test/resources/results/app10
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app12 b/springdoc-openapi-ui/src/test/resources/results/app12
@@ -52,7 +52,8 @@ presets: [
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app21 b/springdoc-openapi-ui/src/test/resources/results/app21
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/rest/v3/api-docs/swagger-config"
+  "configUrl" : "/rest/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app24 b/springdoc-openapi-ui/src/test/resources/results/app24
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/foo/bar"
+  "configUrl" : "/foo/bar",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app26 b/springdoc-openapi-ui/src/test/resources/results/app26
@@ -52,7 +52,8 @@
         layout: "BaseLayout" ,
 
   "configUrl" : "/v3/api-docs/swagger-config",
-  "layout" : "BaseLayout"
+  "layout" : "BaseLayout",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app28 b/springdoc-openapi-ui/src/test/resources/results/app28
@@ -52,7 +52,8 @@
         layout: "StandaloneLayout" ,
 
   "configUrl" : "/v3/api-docs/swagger-config",
-  "filter" : "false"
+  "filter" : "false",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app5 b/springdoc-openapi-ui/src/test/resources/results/app5
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/context-path/v3/api-docs/swagger-config"
+  "configUrl" : "/context-path/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app5-contextpath b/springdoc-openapi-ui/src/test/resources/results/app5-contextpath
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/context-path/servlet-path/v3/api-docs/swagger-config"
+  "configUrl" : "/context-path/servlet-path/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app7 b/springdoc-openapi-ui/src/test/resources/results/app7
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-ui/src/test/resources/results/app9 b/springdoc-openapi-ui/src/test/resources/results/app9
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index1-configurl b/springdoc-openapi-webflux-ui/src/test/resources/results/index1-configurl
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/foo/bar"
+  "configUrl" : "/foo/bar",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index1-default b/springdoc-openapi-webflux-ui/src/test/resources/results/index1-default
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index1-filter b/springdoc-openapi-webflux-ui/src/test/resources/results/index1-filter
@@ -52,7 +52,8 @@
         layout: "StandaloneLayout" ,
 
   "configUrl" : "/v3/api-docs/swagger-config",
-  "filter" : "false"
+  "filter" : "false",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index1-layout b/springdoc-openapi-webflux-ui/src/test/resources/results/index1-layout
@@ -52,7 +52,8 @@
         layout: "BaseLayout" ,
 
   "configUrl" : "/v3/api-docs/swagger-config",
-  "layout" : "BaseLayout"
+  "layout" : "BaseLayout",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index3 b/springdoc-openapi-webflux-ui/src/test/resources/results/index3
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/documentation/v3/api-docs/swagger-config"
+  "configUrl" : "/documentation/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index5 b/springdoc-openapi-webflux-ui/src/test/resources/results/index5
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index6 b/springdoc-openapi-webflux-ui/src/test/resources/results/index6
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region

diff --git a/springdoc-openapi-webflux-ui/src/test/resources/results/index7 b/springdoc-openapi-webflux-ui/src/test/resources/results/index7
@@ -51,7 +51,8 @@
         ],
         layout: "StandaloneLayout" ,
 
-  "configUrl" : "/v3/api-docs/swagger-config"
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
 
       });
       // End Swagger UI call region