code review

Author: bnasslahsen

pom.xml

@@ -1,4 +1,6 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xmlns="http://maven.apache.org/POM/4.0.0"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.springdoc</groupId>
 	<artifactId>springdoc-openapi</artifactId>

springdoc-openapi-common/pom.xml

@@ -1,4 +1,6 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xmlns="http://maven.apache.org/POM/4.0.0"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>springdoc-openapi-common</artifactId>
 	<name>${project.artifactId}</name>

springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java

@@ -151,6 +151,10 @@ public static void removeRequestWrapperToIgnore(Class<?>... classes) {
 			PARAM_TYPES_TO_IGNORE.removeAll(Arrays.asList(classes));
 	}
 
+	public static boolean isRequestTypeToIgnore(Class<?> rawClass) {
+		return PARAM_TYPES_TO_IGNORE.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
+	}
+
 	public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 			Operation operation, MethodAttributes methodAttributes, OpenAPI openAPI) {
 		// Documentation
@@ -262,11 +266,6 @@ protected boolean isParamToIgnore(MethodParameter parameter) {
 		return isRequestTypeToIgnore(parameter.getParameterType());
 	}
 
-	public static boolean isRequestTypeToIgnore(Class<?> rawClass) {
-		return PARAM_TYPES_TO_IGNORE.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
-	}
-
-
 	private void setParams(Operation operation, List<Parameter> operationParameters, RequestBodyInfo requestBodyInfo) {
 		if (!CollectionUtils.isEmpty(operationParameters))
 			operation.setParameters(operationParameters);

springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java

@@ -24,7 +24,7 @@
 
 public final class Constants {
 
-	public static final String SPRINGDOC_PREFIX="springdoc";
+	public static final String SPRINGDOC_PREFIX = "springdoc";
 
 	public static final String DEFAULT_API_DOCS_URL = "/v3/api-docs";
 
@@ -48,6 +48,8 @@ public final class Constants {
 
 	public static final String NULL = ":#{null}";
 
+	public static final String MVC_SERVLET_PATH = "${spring.mvc.servlet.path" + NULL + "}";
+
 	public static final String SPRINGDOC_SHOW_ACTUATOR = "springdoc.show-actuator";
 
 	public static final String SPRINGDOC_ACTUATOR_TAG = "Actuator";
@@ -74,7 +76,7 @@ public final class Constants {
 
 	public static final String DEFAULT_GROUP_NAME = "springdocDefault";
 
-	public static final String GROUP_CONFIG_FIRST_PROPERTY ="springdoc.group-configs[0].group";
+	public static final String GROUP_CONFIG_FIRST_PROPERTY = "springdoc.group-configs[0].group";
 
 	public static final String GROUP_NAME_NOT_NULL = "Group name can not be null";
 

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java

@@ -87,6 +87,10 @@ public static void removeAnnotationsToIgnore(Class<?>... classes) {
 			ANNOTATIOSN_TO_IGNORE.removeAll(Arrays.asList(classes));
 	}
 
+	public static boolean isFile(Class type) {
+		return FILE_TYPES.stream().anyMatch(clazz -> clazz.isAssignableFrom(type));
+	}
+
 	Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul) {
 		Parameter result = paramCalcul;
 		if (paramCalcul != null && paramCalcul.getName() != null) {
@@ -310,8 +314,4 @@ else if (type instanceof WildcardType) {
 		}
 		return false;
 	}
-
-	public static boolean isFile(Class type) {
-		return FILE_TYPES.stream().anyMatch(clazz -> clazz.isAssignableFrom(type));
-	}
 }

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java

@@ -60,8 +60,6 @@
 @SuppressWarnings("rawtypes")
 public class GenericResponseBuilder {
 
-	private List<ControllerAdviceInfo> controllerAdviceInfos = new ArrayList<>();
-
 	private final OperationBuilder operationBuilder;
 
 	private final List<ReturnTypeParser> returnTypeParsers;
@@ -70,6 +68,8 @@ public class GenericResponseBuilder {
 
 	private final PropertyResolverUtils propertyResolverUtils;
 
+	private List<ControllerAdviceInfo> controllerAdviceInfos = new ArrayList<>();
+
 	public GenericResponseBuilder(OperationBuilder operationBuilder, List<ReturnTypeParser> returnTypeParsers,
 			SpringDocConfigProperties springDocConfigProperties,
 			PropertyResolverUtils propertyResolverUtils) {

springdoc-openapi-common/src/main/java/org/springdoc/core/MethodParameterPojoExtractor.java

@@ -44,6 +44,33 @@
 import org.springframework.lang.Nullable;
 
 class MethodParameterPojoExtractor {
+	private static final Nullable NULLABLE_ANNOTATION = new Nullable() {
+		@Override
+		public Class<? extends Annotation> annotationType() {
+			return Nullable.class;
+		}
+	};
+
+	private static final List<Predicate<Class<?>>> SIMPLE_TYPE_PREDICATES = new ArrayList<>();
+
+	private static final Set<Class<?>> SIMPLE_TYPES = new HashSet<>();
+
+	static {
+		SIMPLE_TYPES.add(CharSequence.class);
+		SIMPLE_TYPES.add(Optional.class);
+		SIMPLE_TYPES.add(OptionalInt.class);
+		SIMPLE_TYPES.add(OptionalLong.class);
+		SIMPLE_TYPES.add(OptionalDouble.class);
+
+		SIMPLE_TYPES.add(Map.class);
+		SIMPLE_TYPES.add(Iterable.class);
+
+		SIMPLE_TYPE_PREDICATES.add(Class::isPrimitive);
+		SIMPLE_TYPE_PREDICATES.add(Class::isEnum);
+		SIMPLE_TYPE_PREDICATES.add(Class::isArray);
+		SIMPLE_TYPE_PREDICATES.add(MethodParameterPojoExtractor::isSwaggerPrimitiveType);
+	}
+
 	static Stream<MethodParameter> extractFrom(Class<?> clazz) {
 		return extractFrom(clazz, "");
 	}
@@ -100,20 +127,9 @@ private static boolean isSimpleType(Class<?> clazz) {
 
 	private static boolean isSwaggerPrimitiveType(Class<?> clazz) {
 		PrimitiveType primitiveType = PrimitiveType.fromType(clazz);
-		return  primitiveType != null;
+		return primitiveType != null;
 	}
 
-	private static final Nullable NULLABLE_ANNOTATION = new Nullable() {
-		@Override
-		public Class<? extends Annotation> annotationType() {
-			return Nullable.class;
-		}
-	};
-
-	private static final List<Predicate<Class<?>>> SIMPLE_TYPE_PREDICATES = new ArrayList<>();
-
-	private static final Set<Class<?>> SIMPLE_TYPES = new HashSet<>();
-
 	static void addSimpleTypePredicate(Predicate<Class<?>> predicate) {
 		SIMPLE_TYPE_PREDICATES.add(predicate);
 	}
@@ -125,20 +141,4 @@ static void addSimpleTypes(Class<?>... classes) {
 	static void removeSimpleTypes(Class<?>... classes) {
 		SIMPLE_TYPES.removeAll(Arrays.asList(classes));
 	}
-
-	static {
-		SIMPLE_TYPES.add(CharSequence.class);
-		SIMPLE_TYPES.add(Optional.class);
-		SIMPLE_TYPES.add(OptionalInt.class);
-		SIMPLE_TYPES.add(OptionalLong.class);
-		SIMPLE_TYPES.add(OptionalDouble.class);
-
-		SIMPLE_TYPES.add(Map.class);
-		SIMPLE_TYPES.add(Iterable.class);
-
-		SIMPLE_TYPE_PREDICATES.add(Class::isPrimitive);
-		SIMPLE_TYPE_PREDICATES.add(Class::isEnum);
-		SIMPLE_TYPE_PREDICATES.add(Class::isArray);
-		SIMPLE_TYPE_PREDICATES.add(MethodParameterPojoExtractor::isSwaggerPrimitiveType);
-	}
 }

springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIBuilder.java

@@ -447,14 +447,14 @@ public OpenAPI calculateCachedOpenAPI() {
 		return cachedOpenAPI;
 	}
 
-	public void setCachedOpenAPI(OpenAPI cachedOpenAPI) {
-		this.cachedOpenAPI = cachedOpenAPI;
-	}
-
 	public OpenAPI getCachedOpenAPI() {
 		return cachedOpenAPI;
 	}
 
+	public void setCachedOpenAPI(OpenAPI cachedOpenAPI) {
+		this.cachedOpenAPI = cachedOpenAPI;
+	}
+
 	public OpenAPI getCalculatedOpenAPI() {
 		return calculatedOpenAPI;
 	}

springdoc-openapi-common/src/main/java/org/springdoc/core/ReturnTypeParser.java

@@ -28,12 +28,6 @@
 
 public interface ReturnTypeParser {
 
-	default Type getReturnType(MethodParameter methodParameter) {
-		if (methodParameter.getGenericParameterType() instanceof ParameterizedType)
-			return ReturnTypeParser.resolveType(methodParameter.getGenericParameterType(), methodParameter.getContainingClass());
-		return methodParameter.getParameterType();
-	}
-
 	/**
 	 * This is a copy of GenericTypeResolver.resolveType which is not available on spring 4.
 	 * This also keeps compatibility with spring-boot 1 applications.
@@ -114,5 +108,11 @@ static ResolvableType resolveVariable(TypeVariable<?> typeVariable, ResolvableTy
 		}
 		return ResolvableType.NONE;
 	}
+
+	default Type getReturnType(MethodParameter methodParameter) {
+		if (methodParameter.getGenericParameterType() instanceof ParameterizedType)
+			return ReturnTypeParser.resolveType(methodParameter.getGenericParameterType(), methodParameter.getContainingClass());
+		return methodParameter.getParameterType();
+	}
 }
 

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java

@@ -136,7 +136,9 @@ public void setPathsToMatch(List<String> pathsToMatch) {
 		this.pathsToMatch = pathsToMatch;
 	}
 
-	public Cache getCache() { return cache; }
+	public Cache getCache() {
+		return cache;
+	}
 
 	public void setCache(Cache cache) {
 		this.cache = cache;