HAL representation (_embedded and _links) in definitions when application returning plain json. Fixes #870.

Author: bnasslahsen

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/DataRestHalProvider.java

@@ -30,6 +30,7 @@
 import io.swagger.v3.core.util.Json;
 import org.springdoc.hateoas.HateoasHalProvider;
 
+import org.springframework.boot.autoconfigure.hateoas.HateoasProperties;
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
 
@@ -49,7 +50,8 @@ public class DataRestHalProvider extends HateoasHalProvider {
 	 *
 	 * @param repositoryRestConfigurationOptional the repository rest configuration optional
 	 */
-	public DataRestHalProvider(Optional<RepositoryRestConfiguration> repositoryRestConfigurationOptional) {
+	public DataRestHalProvider(Optional<RepositoryRestConfiguration> repositoryRestConfigurationOptional,Optional<HateoasProperties> hateoasPropertiesOptional) {
+		super(hateoasPropertiesOptional);
 		this.repositoryRestConfigurationOptional = repositoryRestConfigurationOptional;
 	}
 

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

@@ -48,6 +48,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties;
+import org.springframework.boot.autoconfigure.hateoas.HateoasProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
@@ -101,14 +102,15 @@ DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer(Optional
 	 * Hal provider data rest hal provider.
 	 *
 	 * @param repositoryRestConfiguration the repository rest configuration
+	 * @param hateoasPropertiesOptional the hateoas properties optional
 	 * @return the data rest hal provider
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@Primary
 	@Lazy(false)
-	DataRestHalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration) {
-		return new DataRestHalProvider(repositoryRestConfiguration);
+	DataRestHalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration,Optional<HateoasProperties> hateoasPropertiesOptional) {
+		return new DataRestHalProvider(repositoryRestConfiguration,hateoasPropertiesOptional);
 	}
 
 

springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/HateoasHalProvider.java

@@ -20,10 +20,13 @@
 
 package org.springdoc.hateoas;
 
+import java.util.Optional;
+
 import javax.annotation.PostConstruct;
 
 import io.swagger.v3.core.util.Json;
 
+import org.springframework.boot.autoconfigure.hateoas.HateoasProperties;
 import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
 
 /**
@@ -32,6 +35,20 @@
  */
 public class HateoasHalProvider {
 
+	/**
+	 * The Hateoas properties optional.
+	 */
+	private final Optional<HateoasProperties> hateoasPropertiesOptional;
+
+	/**
+	 * Instantiates a new Hateoas hal provider.
+	 *
+	 * @param hateoasPropertiesOptional the hateoas properties optional
+	 */
+	public HateoasHalProvider(Optional<HateoasProperties> hateoasPropertiesOptional) {
+		this.hateoasPropertiesOptional = hateoasPropertiesOptional;
+	}
+
 	/**
 	 * Init.
 	 */
@@ -49,7 +66,9 @@ protected void init() {
 	 * @return the boolean
 	 */
 	public boolean isHalEnabled() {
-		return true;
+		return hateoasPropertiesOptional
+				.map(HateoasProperties::getUseHalAsDefaultJsonMediaType)
+				.orElse(true);
 	}
 
 }

springdoc-openapi-hateoas/src/main/java/org/springdoc/hateoas/SpringDocHateoasConfiguration.java

@@ -20,6 +20,8 @@
 
 package org.springdoc.hateoas;
 
+import java.util.Optional;
+
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import io.swagger.v3.core.util.Json;
@@ -32,6 +34,7 @@
 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.hateoas.HateoasProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
@@ -53,13 +56,14 @@ public class SpringDocHateoasConfiguration {
 	/**
 	 * Hateoas hal provider hateoas hal provider.
 	 *
+	 * @param hateoasPropertiesOptional the hateoas properties optional
 	 * @return the hateoas hal provider
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	HateoasHalProvider hateoasHalProvider() {
-		return new HateoasHalProvider();
+	HateoasHalProvider hateoasHalProvider(Optional<HateoasProperties> hateoasPropertiesOptional) {
+		return new HateoasHalProvider(hateoasPropertiesOptional);
 	}
 
 	/**

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app6/SpringDocApp6Test.java

@@ -0,0 +1,34 @@
+/*
+ *
+ *  * 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.app6;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+
+@TestPropertySource(properties = "spring.hateoas.use-hal-as-default-json-media-type= false")
+public class SpringDocApp6Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {
+	}
+
+
+}

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app6/controller/ItemController.java

@@ -0,0 +1,38 @@
+package test.org.springdoc.api.app6.controller;
+
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import test.org.springdoc.api.app6.model.Item;
+
+import org.springframework.hateoas.CollectionModel;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.linkTo;
+import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.methodOn;
+
+@RestController
+@RequestMapping(value = "/v1/items", produces = MediaType.APPLICATION_JSON_VALUE)
+@Tag(name = "Item", description = "The Item API")
+public class ItemController {
+
+  List<Item> items = Stream.of(new Item("foo"), new Item("bar")).collect(Collectors.toList());
+
+  @Operation(summary = "Get all items")
+  @GetMapping(produces = {MediaType.APPLICATION_JSON_VALUE})
+  public ResponseEntity<CollectionModel<Item>> getAllItems() {
+
+    CollectionModel<Item> collection = CollectionModel.of(items);
+    collection.add(linkTo(methodOn(ItemController.class).getAllItems()).withSelfRel().expand());
+
+    return new ResponseEntity<>(collection, HttpStatus.OK);
+  }
+}

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app6/model/Item.java

@@ -0,0 +1,32 @@
+package test.org.springdoc.api.app6.model;
+
+import org.springframework.hateoas.Link;
+import org.springframework.hateoas.RepresentationModel;
+
+
+public class Item extends RepresentationModel<Item> {
+
+   private String description;
+
+	public Item(String description) {
+		this.description = description;
+	}
+
+	public Item(Link initialLink, String description) {
+		super(initialLink);
+		this.description = description;
+	}
+
+	public Item(Iterable<Link> initialLinks, String description) {
+		super(initialLinks);
+		this.description = description;
+	}
+
+	public String getDescription() {
+		return description;
+	}
+
+	public void setDescription(String description) {
+		this.description = description;
+	}
+}

springdoc-openapi-hateoas/src/test/resources/results/app6.json

@@ -0,0 +1,109 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "tags": [
+    {
+      "name": "Item",
+      "description": "The Item API"
+    }
+  ],
+  "paths": {
+    "/v1/items": {
+      "get": {
+        "tags": [
+          "Item"
+        ],
+        "summary": "Get all items",
+        "operationId": "getAllItems",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CollectionModelItem"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "CollectionModelItem": {
+        "type": "object",
+        "properties": {
+          "links": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Link"
+            }
+          },
+          "content": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Item"
+            }
+          }
+        }
+      },
+      "Item": {
+        "type": "object",
+        "properties": {
+          "description": {
+            "type": "string"
+          },
+          "links": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Link"
+            }
+          }
+        }
+      },
+      "Link": {
+        "type": "object",
+        "properties": {
+          "rel": {
+            "type": "string"
+          },
+          "href": {
+            "type": "string"
+          },
+          "hreflang": {
+            "type": "string"
+          },
+          "media": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          },
+          "deprecation": {
+            "type": "string"
+          },
+          "profile": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}