Support for Groovy metaclass/metadata. Fixes #509

Author: bnasslahsen

springdoc-openapi-common/pom.xml

@@ -41,5 +41,10 @@
 			<groupId>org.apache.commons</groupId>
 			<artifactId>commons-lang3</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy</artifactId>
+			<optional>true</optional>
+		</dependency>
 	</dependencies>
 </project>

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

@@ -257,9 +257,14 @@ protected boolean isParamToIgnore(MethodParameter parameter) {
 			return true;
 		if (parameter.getParameterAnnotation(PathVariable.class) != null || parameter.getParameterAnnotation(RequestParam.class) != null)
 			return false;
-		return PARAM_TYPES_TO_IGNORE.stream().anyMatch(paramToIgnore -> paramToIgnore.isAssignableFrom(parameter.getParameterType()));
+		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/SpringDocConfiguration.java

@@ -24,6 +24,7 @@
 import java.util.Optional;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import groovy.lang.MetaClass;
 import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
@@ -32,6 +33,7 @@
 import org.springdoc.core.converters.AdditionalModelsConverter;
 import org.springdoc.core.converters.ModelConverterRegistrar;
 import org.springdoc.core.converters.PropertyCustomizingConverter;
+import org.springdoc.core.converters.RequestTypeToIgnoreConverter;
 import org.springdoc.core.converters.ResponseSupportConverter;
 import org.springdoc.core.customizers.OpenApiBuilderCustomiser;
 import org.springdoc.core.customizers.OpenApiCustomiser;
@@ -41,6 +43,7 @@
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
 import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
@@ -82,56 +85,69 @@ ResponseSupportConverter responseSupportConverter() {
 		return new ResponseSupportConverter();
 	}
 
+	@ConditionalOnClass(value = { MetaClass.class })
+	class GroovyProvider {
+		@Bean
+		Object ignoreGroovyMetaClass () {
+			SpringDocUtils.getConfig().addRequestWrapperToIgnore(MetaClass.class);
+			return null;
+		}
+		@Bean
+		RequestTypeToIgnoreConverter requestTypeToIgnoreConverter() {
+			return new RequestTypeToIgnoreConverter();
+		}
+	}
+
 	@Bean
-	public OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context,
+	OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context,
 			SecurityParser securityParser,
 			SpringDocConfigProperties springDocConfigProperties,
 			Optional<List<OpenApiBuilderCustomiser>> openApiBuilderCustomisers) {
 		return new OpenAPIBuilder(openAPI, context, securityParser, springDocConfigProperties, openApiBuilderCustomisers);
 	}
 
 	@Bean
-	public ModelConverterRegistrar modelConverterRegistrar(Optional<List<ModelConverter>> modelConverters) {
+	ModelConverterRegistrar modelConverterRegistrar(Optional<List<ModelConverter>> modelConverters) {
 		return new ModelConverterRegistrar(modelConverters.orElse(Collections.emptyList()));
 	}
 
 	@Bean
 	@ConditionalOnWebApplication
-	public OperationBuilder operationBuilder(GenericParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
+	OperationBuilder operationBuilder(GenericParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
 			SecurityParser securityParser, PropertyResolverUtils propertyResolverUtils) {
 		return new OperationBuilder(parameterBuilder, requestBodyBuilder,
 				securityParser, propertyResolverUtils);
 	}
 
 	@Bean
-	public PropertyResolverUtils propertyResolverUtils(ConfigurableBeanFactory factory) {
+	PropertyResolverUtils propertyResolverUtils(ConfigurableBeanFactory factory) {
 		return new PropertyResolverUtils(factory);
 	}
 
 	@Bean
 	@ConditionalOnWebApplication
-	public RequestBodyBuilder requestBodyBuilder(GenericParameterBuilder parameterBuilder) {
+	RequestBodyBuilder requestBodyBuilder(GenericParameterBuilder parameterBuilder) {
 		return new RequestBodyBuilder(parameterBuilder);
 	}
 
 	@Bean
-	public SecurityParser securityParser(PropertyResolverUtils propertyResolverUtils) {
+	SecurityParser securityParser(PropertyResolverUtils propertyResolverUtils) {
 		return new SecurityParser(propertyResolverUtils);
 	}
 
 	@Bean
-	public ReturnTypeParser genericReturnTypeParser() {
+	ReturnTypeParser genericReturnTypeParser() {
 		return new ReturnTypeParser() {};
 	}
 
 	@Bean
-	public GenericParameterBuilder parameterBuilder(PropertyResolverUtils propertyResolverUtils) {
+	GenericParameterBuilder parameterBuilder(PropertyResolverUtils propertyResolverUtils) {
 		return new GenericParameterBuilder(propertyResolverUtils);
 	}
 
 	@Bean
 	@ConditionalOnProperty(SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES)
-	public OpenApiCustomiser propertiesResolverForSchema(PropertyResolverUtils propertyResolverUtils, OpenAPIBuilder openAPIBuilder) {
+	OpenApiCustomiser propertiesResolverForSchema(PropertyResolverUtils propertyResolverUtils, OpenAPIBuilder openAPIBuilder) {
 		return openApi -> {
 			Components components = openApi.getComponents();
 			Map<String, Schema> schemas = components.getSchemas();
@@ -147,14 +163,14 @@ static class ConditionOnCacheOrGroupedOpenApi extends AnyNestedCondition {
 
 		@Bean
 		@ConditionalOnBean(GroupedOpenApi.class)
-		public BeanFactoryPostProcessor beanFactoryPostProcessor1() {
+		BeanFactoryPostProcessor beanFactoryPostProcessor1() {
 			return getBeanFactoryPostProcessor();
 		}
 
 		@Bean
 		@ConditionalOnProperty(name = SPRINGDOC_CACHE_DISABLED)
 		@ConditionalOnMissingBean(GroupedOpenApi.class)
-		public BeanFactoryPostProcessor beanFactoryPostProcessor2() {
+		BeanFactoryPostProcessor beanFactoryPostProcessor2() {
 			return getBeanFactoryPostProcessor();
 		}
 

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/RequestTypeToIgnoreConverter.java

@@ -0,0 +1,27 @@
+package org.springdoc.core.converters;
+
+import java.util.Iterator;
+
+import com.fasterxml.jackson.databind.JavaType;
+import io.swagger.v3.core.converter.AnnotatedType;
+import io.swagger.v3.core.converter.ModelConverter;
+import io.swagger.v3.core.converter.ModelConverterContext;
+import io.swagger.v3.core.util.Json;
+import io.swagger.v3.oas.models.media.Schema;
+import org.springdoc.core.AbstractRequestBuilder;
+
+public class RequestTypeToIgnoreConverter implements ModelConverter {
+
+	@Override
+	public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
+		if (type.isSchemaProperty()) {
+			JavaType javaType = Json.mapper().constructType(type.getType());
+			if (type != null) {
+				Class<?> cls = javaType.getRawClass();
+				if(AbstractRequestBuilder.isRequestTypeToIgnore(cls))
+					return null;
+			}
+		}
+		return (chain.hasNext()) ? chain.next().resolve(type, context, chain) : null;
+	}
+}

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/SpringDocDataRestConfiguration.java

@@ -57,12 +57,11 @@ public class SpringDocDataRestConfiguration {
 				.replaceWithClass(org.springframework.data.domain.PageRequest.class, Pageable.class);
 	}
 
-	@Configuration
 	@ConditionalOnClass(value = { QuerydslBindingsFactory.class })
 	class QuerydslProvider {
 
 		@Bean
-		public QuerydslPredicateOperationCustomizer queryDslQuerydslPredicateOperationCustomizer(Optional<QuerydslBindingsFactory> querydslBindingsFactory) {
+		QuerydslPredicateOperationCustomizer queryDslQuerydslPredicateOperationCustomizer(Optional<QuerydslBindingsFactory> querydslBindingsFactory) {
 			if (querydslBindingsFactory.isPresent()) {
 				getConfig().addRequestWrapperToIgnore(Predicate.class);
 				return new QuerydslPredicateOperationCustomizer(querydslBindingsFactory.get());
@@ -71,12 +70,11 @@ public QuerydslPredicateOperationCustomizer queryDslQuerydslPredicateOperationCu
 		}
 	}
 
-	@Configuration
 	@ConditionalOnClass(RepositoryRestConfiguration.class)
 	class HalProviderConfiguration {
 
 		@Bean
-		public HalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration) {
+		HalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration) {
 			return repositoryRestConfiguration.isPresent() ? new HalProvider(repositoryRestConfiguration.get()) : null;
 		}
 
@@ -87,7 +85,7 @@ public HalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryR
 		 * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)
 		 */
 		@Bean
-		public OpenApiCustomiser linksSchemaCustomiser(Optional<RepositoryRestConfiguration> repositoryRestConfiguration) {
+		OpenApiCustomiser linksSchemaCustomiser(Optional<RepositoryRestConfiguration> repositoryRestConfiguration) {
 			if (!repositoryRestConfiguration.isPresent() || !repositoryRestConfiguration.get().useHalAsDefaultJsonMediaType()) {
 				return openApi -> {
 				};

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/converters/Pageable.java

@@ -18,15 +18,17 @@
 
 package org.springdoc.core.converters;
 
-import io.swagger.v3.oas.annotations.media.ArraySchema;
-import io.swagger.v3.oas.annotations.media.Schema;
-import org.springframework.lang.Nullable;
+import java.util.List;
+import java.util.Objects;
 
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 import javax.validation.constraints.NotNull;
-import java.util.List;
-import java.util.Objects;
+
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+import org.springframework.lang.Nullable;
 
 @NotNull
 public class Pageable {

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/converters/PageableAsQueryParam.java

@@ -18,17 +18,17 @@
 
 package org.springdoc.core.converters;
 
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
-
 /**
  * @deprecated Use {@link org.springdoc.api.annotations.ParameterObject} annotation
  * on {@link org.springframework.data.domain.Pageable} method parameter instead.

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app7/HelloController.java

@@ -18,15 +18,17 @@
 
 package test.org.springdoc.api.app7;
 
+import java.util.List;
+
+import javax.validation.constraints.NotNull;
+
 import org.springdoc.api.annotations.ParameterObject;
+
 import org.springframework.data.domain.Pageable;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import javax.validation.constraints.NotNull;
-import java.util.List;
-
 @RestController
 public class HelloController {
 

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app7/SpringDocApp7Test.java

@@ -18,9 +18,10 @@
 
 package test.org.springdoc.api.app7;
 
-import org.springframework.boot.autoconfigure.SpringBootApplication;
 import test.org.springdoc.api.AbstractSpringDocTest;
 
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
 public class SpringDocApp7Test extends AbstractSpringDocTest {
 
 	@SpringBootApplication

springdoc-openapi-security/src/main/java/org/springdoc/core/SpringDocSecurityConfiguration.java

@@ -43,7 +43,7 @@ public class SpringDocSecurityConfiguration {
 	@ConditionalOnBean(FrameworkEndpointHandlerMapping.class)
 	class SpringSecurityOAuth2ProviderConfiguration {
 		@Bean
-		public SpringSecurityOAuth2Provider springSecurityOAuth2Provider(FrameworkEndpointHandlerMapping oauth2EndpointHandlerMapping) {
+		SpringSecurityOAuth2Provider springSecurityOAuth2Provider(FrameworkEndpointHandlerMapping oauth2EndpointHandlerMapping) {
 			return new SpringSecurityOAuth2Provider(oauth2EndpointHandlerMapping);
 		}
 	}