project review

Author: bnasslahsen

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

@@ -22,8 +22,8 @@
 
 import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.util.Json;
-
 import org.springdoc.core.hal.CollectionModelContentConverter;
+
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
 

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

@@ -29,8 +29,9 @@
 import io.swagger.v3.oas.models.media.StringSchema;
 import org.springdoc.core.converters.Pageable;
 import org.springdoc.core.customizers.OpenApiCustomiser;
-
 import org.springdoc.core.hal.RepresentationModelLinksOASMixin;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -51,31 +52,36 @@ public class SpringDocDataRestConfiguration {
 		.replaceWithClass(org.springframework.data.domain.PageRequest.class,Pageable.class);
 	}
 
-    @Bean
-    public HalProvider halProvider(RepositoryRestConfiguration repositoryRestConfiguration) {
-        return new HalProvider(repositoryRestConfiguration);
-    }
+	@Configuration
+	@ConditionalOnClass(RepositoryRestConfiguration.class)
+	class HalProviderConfiguration {
 
-	/**
-	 * Registers an OpenApiCustomiser and a jackson mixin to ensure the definition of `Links` matches the serialized
-	 * output. This is done because the customer serializer converts the data to a map before serializing it.
-	 *
-	 * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)
-	 */
-    @Bean
-    public OpenApiCustomiser linksSchemaCustomiser(RepositoryRestConfiguration repositoryRestConfiguration) {
-        if (!repositoryRestConfiguration.useHalAsDefaultJsonMediaType()) {
-            return openApi -> {};
-        }
-        Json.mapper().addMixIn(RepresentationModel.class, RepresentationModelLinksOASMixin.class);
+		@Bean
+		public HalProvider halProvider(RepositoryRestConfiguration repositoryRestConfiguration) {
+			return new HalProvider(repositoryRestConfiguration);
+		}
 
-        ResolvedSchema resolvedLinkSchema = ModelConverters.getInstance()
-                .resolveAsResolvedSchema(new AnnotatedType(Link.class));
+		/**
+		 * Registers an OpenApiCustomiser and a jackson mixin to ensure the definition of `Links` matches the serialized
+		 * output. This is done because the customer serializer converts the data to a map before serializing it.
+		 *
+		 * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)
+		 */
+		@Bean
+		public OpenApiCustomiser linksSchemaCustomiser(RepositoryRestConfiguration repositoryRestConfiguration) {
+			if (!repositoryRestConfiguration.useHalAsDefaultJsonMediaType()) {
+				return openApi -> {};
+			}
+			Json.mapper().addMixIn(RepresentationModel.class, RepresentationModelLinksOASMixin.class);
 
-        return openApi -> openApi
-				.schema("Link", resolvedLinkSchema.schema)
-				.schema("Links", new MapSchema()
-						.additionalProperties(new StringSchema())
-						.additionalProperties(new ObjectSchema().$ref("#/components/schemas/Link")));
-    }
+			ResolvedSchema resolvedLinkSchema = ModelConverters.getInstance()
+					.resolveAsResolvedSchema(new AnnotatedType(Link.class));
+
+			return openApi -> openApi
+					.schema("Link", resolvedLinkSchema.schema)
+					.schema("Links", new MapSchema()
+							.additionalProperties(new StringSchema())
+							.additionalProperties(new ObjectSchema().$ref("#/components/schemas/Link")));
+		}
+	}
 }

springdoc-openapi-data-rest/src/test/resources/results/app2.json

@@ -172,9 +172,12 @@
         "type": "object",
         "properties": {
           "_embedded": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/EntityModelEmployee"
+            "type": "object",
+            "additionalProperties": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/EntityModelEmployee"
+              }
             }
           },
           "_links": {