Upgrade swagger-api to 2.1.1

springdoc · Apr 5, 2020 · aa368c4 · aa368c4
1 parent 43d943f
commit aa368c4
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 16 deletions.
diff --git a/pom.xml b/pom.xml
@@ -71,7 +71,7 @@
 		<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
 		<maven-release-plugin.version>2.5.3</maven-release-plugin.version>
 		<nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
-		<swagger-api.version>2.1.1</swagger-api.version>
+		<swagger-api.version>2.1.2</swagger-api.version>
 		<swagger-ui.version>3.25.0</swagger-ui.version>
 		<spring-security-oauth2.version>2.3.8.RELEASE</spring-security-oauth2.version>
 		<classgraph.version>4.8.44</classgraph.version>

diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocAnnotationsUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocAnnotationsUtils.java
@@ -31,9 +31,11 @@
 import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
 import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.Content;
 import io.swagger.v3.oas.models.media.MediaType;
 import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.media.StringSchema;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
 
@@ -148,7 +150,15 @@ private static MediaType getMediaType(Schema schema, Components components, Json
 		MediaType mediaType = new MediaType();
 		if (!annotationContent.schema().hidden()) {
 			if (components != null) {
-				getSchema(annotationContent, components, jsonViewAnnotation).ifPresent(mediaType::setSchema);
+				try {
+					getSchema(annotationContent, components, jsonViewAnnotation).ifPresent(mediaType::setSchema);
+				}
+				catch (Exception e) {
+					if (isArray(annotationContent))
+						mediaType.setSchema(new ArraySchema().items(new StringSchema()));
+					else
+						mediaType.setSchema(new StringSchema());
+				}
 			}
 			else {
 				mediaType.setSchema(schema);
@@ -157,4 +167,16 @@ private static MediaType getMediaType(Schema schema, Components components, Json
 		return mediaType;
 	}
 
+	private static boolean isArray(io.swagger.v3.oas.annotations.media.Content annotationContent){
+		Class<?> schemaImplementation = annotationContent.schema().implementation();
+		boolean isArray = false;
+		if (schemaImplementation == Void.class) {
+			schemaImplementation = annotationContent.array().schema().implementation();
+			if (schemaImplementation != Void.class) {
+				isArray = true;
+			}
+		}
+		return isArray;
+	}
+
 }
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app41.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app41.json
@@ -13,6 +13,9 @@
   "paths": {
     "/file": {
       "get": {
+        "tags": [
+          "hello-controller"
+        ],
         "description": "Download file",
         "operationId": "getFile",
         "parameters": [
@@ -27,33 +30,33 @@
           }
         ],
         "responses": {
-          "200": {
-            "description": "File resource",
+          "500": {
+            "description": "Unexpected error",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "string",
-                  "format": "binary"
+                  "type": "string"
                 }
               }
             }
           },
-          "400": {
-            "description": "Wrong request",
+          "200": {
+            "description": "File resource",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "error"
+                  "type": "string",
+                  "format": "binary"
                 }
               }
             }
           },
-          "500": {
-            "description": "Unexpected error",
+          "400": {
+            "description": "Wrong request",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "error"
+                  "type": "string"
                 }
               }
             }
@@ -62,6 +65,5 @@
       }
     }
   },
-  "components": {
-  }
-}
+  "components": {}
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app6.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app6.json
@@ -29,7 +29,8 @@
                       "type": "string"
                     },
                     {
-                      "type": "integer"
+                      "type": "integer",
+                      "format": "int32"
                     }
                   ]
                 },