Added support for @hidden on response class. Fixes #826

bnasslahsen · bnasslahsen · commit 8a8ae05e1c4b · 2020-08-18T21:17:04.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java
@@ -353,7 +353,7 @@ protected Parameter customiseParameter(Parameter parameter, ParameterInfo parame
 	 * @return the boolean
 	 */
 	public boolean isParamToIgnore(MethodParameter parameter) {
-		if (parameterBuilder.isAnnotationToIgnore(parameter))
+		if (SpringDocAnnotationsUtils.isAnnotationToIgnore(parameter))
 			return true;
 		if ((parameter.getParameterAnnotation(PathVariable.class) != null && parameter.getParameterAnnotation(PathVariable.class).required())
 				|| (parameter.getParameterAnnotation(RequestParam.class) != null && parameter.getParameterAnnotation(RequestParam.class).required())
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java
@@ -34,7 +34,6 @@
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.core.util.Json;
-import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.enums.Explode;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
 import io.swagger.v3.oas.models.Components;
@@ -51,9 +50,7 @@
 
 import org.springframework.core.MethodParameter;
 import org.springframework.core.ResolvableType;
-import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.core.io.Resource;
-import org.springframework.web.bind.annotation.RequestAttribute;
 import org.springframework.web.multipart.MultipartFile;
 
 /**
@@ -68,11 +65,6 @@ public class GenericParameterBuilder {
 	 */
 	private static final List<Class<?>> FILE_TYPES = new ArrayList<>();
 
-	/**
-	 * The constant ANNOTATIOSN_TO_IGNORE.
-	 */
-	private static final List<Class> ANNOTATIOSN_TO_IGNORE = new ArrayList<>();
-
 	/**
 	 * The constant LOGGER.
 	 */
@@ -81,8 +73,6 @@ public class GenericParameterBuilder {
 	static {
 		FILE_TYPES.add(MultipartFile.class);
 		FILE_TYPES.add(Resource.class);
-		ANNOTATIOSN_TO_IGNORE.add(Hidden.class);
-		ANNOTATIOSN_TO_IGNORE.add(RequestAttribute.class);
 	}
 
 	/**
@@ -108,26 +98,6 @@ public static void addFileType(Class<?>... classes) {
 		FILE_TYPES.addAll(Arrays.asList(classes));
 	}
 
-	/**
-	 * Add annotations to ignore.
-	 *
-	 * @param classes the classes
-	 */
-	public static void addAnnotationsToIgnore(Class<?>... classes) {
-		ANNOTATIOSN_TO_IGNORE.addAll(Arrays.asList(classes));
-	}
-
-	/**
-	 * Remove annotations to ignore.
-	 *
-	 * @param classes the classes
-	 */
-	public static void removeAnnotationsToIgnore(Class<?>... classes) {
-		List classesToIgnore = Arrays.asList(classes);
-		if (ANNOTATIOSN_TO_IGNORE.containsAll(classesToIgnore))
-			ANNOTATIOSN_TO_IGNORE.removeAll(Arrays.asList(classes));
-	}
-
 	/**
 	 * Is file boolean.
 	 *
@@ -345,19 +315,6 @@ else if (schemaN instanceof FileSchema || schemaN instanceof ArraySchema && ((Ar
 		return schemaN;
 	}
 
-	/**
-	 * Is annotation to ignore boolean.
-	 *
-	 * @param parameter the parameter
-	 * @return the boolean
-	 */
-	@SuppressWarnings("unchecked")
-	public boolean isAnnotationToIgnore(MethodParameter parameter) {
-		return ANNOTATIOSN_TO_IGNORE.stream().anyMatch(
-				annotation -> parameter.getParameterAnnotation(annotation) != null
-						|| AnnotationUtils.findAnnotation(parameter.getParameterType(), annotation) != null);
-	}
-
 	/**
 	 * Sets examples.
 	 *
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java
@@ -414,7 +414,9 @@ private Type getReturnType(MethodParameter methodParameter) {
 	 * @return the schema
 	 */
 	private Schema<?> calculateSchema(Components components, Type returnType, JsonView jsonView, Annotation[] annotations) {
-		return !isVoid(returnType) ? extractSchema(components, returnType, jsonView,annotations) : null;
+		if (!isVoid(returnType) && !SpringDocAnnotationsUtils.isAnnotationToIgnore(returnType))
+			return extractSchema(components, returnType, jsonView, annotations);
+		return null;
 	}
 
 	/**
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
@@ -22,6 +22,8 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -32,6 +34,7 @@
 import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.converter.ResolvedSchema;
 import io.swagger.v3.core.util.AnnotationsUtils;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.media.ArraySchema;
@@ -45,7 +48,10 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import org.springframework.core.MethodParameter;
+import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.CollectionUtils;
+import org.springframework.web.bind.annotation.RequestAttribute;
 
 /**
  * The type Spring doc annotations utils.
@@ -59,6 +65,16 @@ public class SpringDocAnnotationsUtils extends AnnotationsUtils {
 	 */
 	private static final Logger LOGGER = LoggerFactory.getLogger(SpringDocAnnotationsUtils.class);
 
+	/**
+	 * The constant ANNOTATIOSN_TO_IGNORE.
+	 */
+	private static final List<Class> ANNOTATIONS_TO_IGNORE = new ArrayList<>();
+
+	static {
+		ANNOTATIONS_TO_IGNORE.add(Hidden.class);
+		ANNOTATIONS_TO_IGNORE.add(RequestAttribute.class);
+	}
+
 	/**
 	 * Resolve schema from type schema.
 	 *
@@ -208,6 +224,51 @@ public static void mergeSchema(Content existingContent, Schema<?> schemaN, Strin
 			existingContent.addMediaType(mediaTypeStr, new io.swagger.v3.oas.models.media.MediaType().schema(schemaN));
 	}
 
+	/**
+	 * Is annotation to ignore boolean.
+	 *
+	 * @param parameter the parameter
+	 * @return the boolean
+	 */
+	@SuppressWarnings("unchecked")
+	public static boolean isAnnotationToIgnore(MethodParameter parameter) {
+		return ANNOTATIONS_TO_IGNORE.stream().anyMatch(
+				annotation -> parameter.getParameterAnnotation(annotation) != null
+						|| AnnotationUtils.findAnnotation(parameter.getParameterType(), annotation) != null);
+	}
+
+	/**
+	 * Is annotation to ignore boolean.
+	 *
+	 * @param type the type
+	 * @return the boolean
+	 */
+	public static boolean isAnnotationToIgnore(Type type) {
+		return ANNOTATIONS_TO_IGNORE.stream().anyMatch(
+				annotation -> (type instanceof Class
+						&&  AnnotationUtils.findAnnotation((Class<?>) type, annotation) != null));
+	}
+
+	/**
+	 * Add annotations to ignore.
+	 *
+	 * @param classes the classes
+	 */
+	public static void addAnnotationsToIgnore(Class<?>... classes) {
+		ANNOTATIONS_TO_IGNORE.addAll(Arrays.asList(classes));
+	}
+
+	/**
+	 * Remove annotations to ignore.
+	 *
+	 * @param classes the classes
+	 */
+	public static void removeAnnotationsToIgnore(Class<?>... classes) {
+		List classesToIgnore = Arrays.asList(classes);
+		if (ANNOTATIONS_TO_IGNORE.containsAll(classesToIgnore))
+			ANNOTATIONS_TO_IGNORE.removeAll(Arrays.asList(classes));
+	}
+
 	/**
 	 * Add encoding to media type.
 	 *
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocUtils.java
@@ -207,7 +207,7 @@ public SpringDocUtils removeResponseTypeToIgnore(Class<?> cls) {
 	 * @return the spring doc utils
 	 */
 	public SpringDocUtils addAnnotationsToIgnore(Class<?>... classes) {
-		GenericParameterBuilder.addAnnotationsToIgnore(classes);
+		SpringDocAnnotationsUtils.addAnnotationsToIgnore(classes);
 		return this;
 	}
 
@@ -218,7 +218,7 @@ public SpringDocUtils addAnnotationsToIgnore(Class<?>... classes) {
 	 * @return the spring doc utils
 	 */
 	public SpringDocUtils removeAnnotationsToIgnore(Class<?>... classes) {
-		GenericParameterBuilder.removeAnnotationsToIgnore(classes);
+		SpringDocAnnotationsUtils.removeAnnotationsToIgnore(classes);
 		return this;
 	}
 
diff --git a/springdoc-openapi-ui/src/test/resources/results/app1 b/springdoc-openapi-ui/src/test/resources/results/app1
@@ -33,8 +33,8 @@
   <body>
     <div id="swagger-ui"></div>
 
-    <script src="./swagger-ui-bundle.js"> </script>
-    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
     <script>
     window.onload = function() {
       // Begin Swagger UI call region
diff --git a/springdoc-openapi-ui/src/test/resources/results/app10 b/springdoc-openapi-ui/src/test/resources/results/app10
@@ -33,8 +33,8 @@
   <body>
     <div id="swagger-ui"></div>
 
-    <script src="./swagger-ui-bundle.js"> </script>
-    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
     <script>
     window.onload = function() {
       // Begin Swagger UI call region
diff --git a/springdoc-openapi-ui/src/test/resources/results/app7 b/springdoc-openapi-ui/src/test/resources/results/app7
@@ -33,8 +33,8 @@
   <body>
     <div id="swagger-ui"></div>
 
-    <script src="./swagger-ui-bundle.js"> </script>
-    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
     <script>
     window.onload = function() {
       // Begin Swagger UI call region
diff --git a/springdoc-openapi-ui/src/test/resources/results/app9 b/springdoc-openapi-ui/src/test/resources/results/app9
@@ -33,8 +33,8 @@
   <body>
     <div id="swagger-ui"></div>
 
-    <script src="./swagger-ui-bundle.js"> </script>
-    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
     <script>
     window.onload = function() {
       // Begin 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
@@ -33,8 +33,8 @@
   <body>
     <div id="swagger-ui"></div>
 
-    <script src="./swagger-ui-bundle.js"> </script>
-    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
     <script>
     window.onload = function() {
       // Begin 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
@@ -33,8 +33,8 @@
   <body>
     <div id="swagger-ui"></div>
 
-    <script src="./swagger-ui-bundle.js"> </script>
-    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
     <script>
     window.onload = function() {
       // Begin 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
@@ -33,8 +33,8 @@
   <body>
     <div id="swagger-ui"></div>
 
-    <script src="./swagger-ui-bundle.js"> </script>
-    <script src="./swagger-ui-standalone-preset.js"> </script>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
     <script>
     window.onload = function() {
       // Begin Swagger UI call region
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app130/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app130/HelloController.java
@@ -0,0 +1,37 @@
+/*
+ *
+ *  * Copyright 2019-2020 the original author or authors.
+ *  *
+ *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package test.org.springdoc.api.app130;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@PostMapping(value = "/values/data")
+	TrackerData list(TrackerData toto) {
+		return toto;
+	}
+
+	@GetMapping(value = "/values/datakk")
+	TrackerData get(TrackerData toto) {
+		return toto;
+	}
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app130/SpringDocApp130Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app130/SpringDocApp130Test.java
@@ -0,0 +1,38 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
+ *  *
+ *
+ *
+ */
+package test.org.springdoc.api.app130;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+
+/**
+ * Tests Spring meta-annotations as method parameters
+ */
+public class SpringDocApp130Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app130/TrackerData.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app130/TrackerData.java
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app130.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app130.json
