Being able to see the class within an EntityModel as a Schema. Fixes #453

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -84,7 +84,9 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	protected final SpringDocConfigProperties springDocConfigProperties;
 
 	private static final List<Class<?>> ADDITIONAL_REST_CONTROLLERS = new ArrayList<>();
+
 	private static final List<Class<?>> HIDDEN_REST_CONTROLLERS = new ArrayList<>();
+
 	private static final List<Class> DEPRECATED_TYPES = new ArrayList<>();
 
 	private boolean computeDone;
@@ -129,7 +131,8 @@ protected synchronized OpenAPI getOpenApi() {
 			// run the optional customisers
 			openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
 			computeDone = true;
-			this.removeBrokenReferenceDefinitions(openApi);
+			if (springDocConfigProperties.isRemoveBrokenReferenceDefinitions())
+				this.removeBrokenReferenceDefinitions(openApi);
 			openAPIBuilder.setCachedOpenAPI(openApi);
 			openAPIBuilder.resetCalculatedOpenAPI();
 			LOGGER.info("Init duration for springdoc-openapi is: {} ms",
@@ -166,7 +169,7 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
 				continue;
 			}
 
-			RequestMapping reqMappingClass =  AnnotatedElementUtils.findMergedAnnotation(handlerMethod.getBeanType(),
+			RequestMapping reqMappingClass = AnnotatedElementUtils.findMergedAnnotation(handlerMethod.getBeanType(),
 					RequestMapping.class);
 
 			MethodAttributes methodAttributes = new MethodAttributes(springDocConfigProperties.getDefaultConsumesMediaType(), springDocConfigProperties.getDefaultProducesMediaType());
@@ -186,7 +189,7 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
 			}
 
 			// Add documentation from operation annotation
-			io.swagger.v3.oas.annotations.Operation apiOperation =  AnnotatedElementUtils.findMergedAnnotation(method,
+			io.swagger.v3.oas.annotations.Operation apiOperation = AnnotatedElementUtils.findMergedAnnotation(method,
 					io.swagger.v3.oas.annotations.Operation.class);
 
 			calculateJsonView(apiOperation, methodAttributes, method);
@@ -198,7 +201,7 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
 			// compute tags
 			operation = openAPIBuilder.buildTags(handlerMethod, operation, openAPI);
 
-			io.swagger.v3.oas.annotations.parameters.RequestBody requestBodyDoc =  AnnotatedElementUtils.findMergedAnnotation(method,
+			io.swagger.v3.oas.annotations.parameters.RequestBody requestBodyDoc = AnnotatedElementUtils.findMergedAnnotation(method,
 					io.swagger.v3.oas.annotations.parameters.RequestBody.class);
 
 			// RequestBody in Operation
@@ -214,7 +217,7 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
 			ApiResponses apiResponses = responseBuilder.build(components, handlerMethod, operation, methodAttributes);
 			operation.setResponses(apiResponses);
 
-			Set<io.swagger.v3.oas.annotations.callbacks.Callback> apiCallbacks =  AnnotatedElementUtils.findMergedRepeatableAnnotations(method, io.swagger.v3.oas.annotations.callbacks.Callback.class);
+			Set<io.swagger.v3.oas.annotations.callbacks.Callback> apiCallbacks = AnnotatedElementUtils.findMergedRepeatableAnnotations(method, io.swagger.v3.oas.annotations.callbacks.Callback.class);
 
 			// callbacks
 			if (!CollectionUtils.isEmpty(apiCallbacks)) {
@@ -236,7 +239,7 @@ private void calculateJsonView(io.swagger.v3.oas.annotations.Operation apiOperat
 			jsonViewAnnotationForRequestBody = null;
 		}
 		else {
-			jsonViewAnnotation =  AnnotatedElementUtils.findMergedAnnotation(method, JsonView.class);
+			jsonViewAnnotation = AnnotatedElementUtils.findMergedAnnotation(method, JsonView.class);
 			/*
 			 * If one and only one exists, use the @JsonView annotation from the method
 			 * parameter annotated with @RequestBody. Otherwise fall back to the @JsonView
@@ -389,6 +392,7 @@ public static void addRestControllers(Class<?>... classes) {
 	public static void addHiddenRestControllers(Class<?>... classes) {
 		HIDDEN_REST_CONTROLLERS.addAll(Arrays.asList(classes));
 	}
+
 	protected boolean isHiddenRestControllers(Class<?> rawClass) {
 		return HIDDEN_REST_CONTROLLERS.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
 	}

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

@@ -57,6 +57,8 @@ public class SpringDocConfigProperties {
 
 	private boolean overrideWithGenericResponse = true;
 
+	private boolean removeBrokenReferenceDefinitions = true;
+
 	private String defaultConsumesMediaType = MediaType.APPLICATION_JSON_VALUE;
 
 	private String defaultProducesMediaType = MediaType.ALL_VALUE;
@@ -313,4 +315,12 @@ public boolean isOverrideWithGenericResponse() {
 	public void setOverrideWithGenericResponse(boolean overrideWithGenericResponse) {
 		this.overrideWithGenericResponse = overrideWithGenericResponse;
 	}
+
+	public boolean isRemoveBrokenReferenceDefinitions() {
+		return removeBrokenReferenceDefinitions;
+	}
+
+	public void setRemoveBrokenReferenceDefinitions(boolean removeBrokenReferenceDefinitions) {
+		this.removeBrokenReferenceDefinitions = removeBrokenReferenceDefinitions;
+	}
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app6/DatabaseLoader.java

@@ -0,0 +1,47 @@
+/*
+ *
+ *  * 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 org.springframework.boot.CommandLineRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.stereotype.Component;
+
+/**
+ * Pre-load some data using a Spring Boot {@link CommandLineRunner}.
+ *
+ * @author Greg Turnquist
+ */
+@Component
+class DatabaseLoader {
+
+	/**
+	 * Use Spring to inject a {@link EmployeeRepository} that can then load data. Since this will run only after the app
+	 * is operational, the database will be up.
+	 *
+	 * @param repository
+	 */
+	@Bean
+	CommandLineRunner init(EmployeeRepository repository) {
+
+		return args -> {
+			repository.save(new Employee("Frodo", "Baggins", "ring bearer"));
+			repository.save(new Employee("Bilbo", "Baggins", "burglar"));
+		};
+	}
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app6/Employee.java

@@ -0,0 +1,70 @@
+/*
+ *
+ *  * 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 javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * Domain object representing a company employee. Project Lombok keeps actual code at a minimum. {@code @Data} -
+ * Generates getters, setters, toString, hash, and equals functions {@code @Entity} - JPA annotation to flag this class
+ * for DB persistence {@code @NoArgsConstructor} - Create a constructor with no args to support JPA
+ * {@code @AllArgsConstructor} - Create a constructor with all args to support testing
+ * {@code @JsonIgnoreProperties(ignoreUnknow=true)} When converting JSON to Java, ignore any unrecognized attributes.
+ * This is critical for REST because it encourages adding new fields in later versions that won't break. It also allows
+ * things like _links to be ignore as well, meaning HAL documents can be fetched and later posted to the server without
+ * adjustment.
+ *
+ * @author Greg Turnquist
+ */
+@Data
+@Entity
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+@AllArgsConstructor
+class Employee {
+
+	@Id
+	@GeneratedValue
+	private Long id;
+
+	private String firstName;
+
+	private String lastName;
+
+	private String role;
+
+	/**
+	 * Useful constructor when id is not yet known.
+	 *
+	 * @param firstName
+	 * @param lastName
+	 * @param role
+	 */
+	Employee(String firstName, String lastName, String role) {
+
+		this.firstName = firstName;
+		this.lastName = lastName;
+		this.role = role;
+	}
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app6/EmployeeController.java

@@ -0,0 +1,54 @@
+/*
+ *
+ *  * 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 org.springframework.hateoas.EntityModel;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Spring Web {@link RestController} used to generate a REST API.
+ *
+ * @author Greg Turnquist
+ */
+@RestController
+class EmployeeController {
+
+	private final EmployeeRepository repository;
+
+	EmployeeController(EmployeeRepository repository) {
+		this.repository = repository;
+	}
+
+	/**
+	 * Look up a single {@link Employee} and transform it into a REST resource. Then return it through Spring Web's
+	 * {@link ResponseEntity} fluent API.
+	 *
+	 * @param id
+	 */
+	@GetMapping("/employees/{id}")
+	EntityModel<Employee> findOne(@PathVariable long id) {
+
+		return null;
+	}
+
+
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app6/EmployeeRepository.java

@@ -0,0 +1,28 @@
+/*
+ *
+ *  * 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 org.springframework.data.repository.CrudRepository;
+
+/**
+ * A simple Spring Data {@link CrudRepository} for storing {@link Employee}s.
+ *
+ * @author Greg Turnquist
+ */
+interface EmployeeRepository extends CrudRepository<Employee, Long> {
+}

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

@@ -0,0 +1,29 @@
+/*
+ *
+ *  * 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.test.context.TestPropertySource;
+
+@TestPropertySource(properties = "springdoc.remove-broken-reference-definitions=false")
+public class SpringDocApp6Test extends AbstractSpringDocTest {
+
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app6/SpringDocTestApp.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.app6;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.hateoas.server.core.EvoInflectorLinkRelationProvider;
+
+@SpringBootApplication
+public class SpringDocTestApp {
+
+	public static void main(String[] args) {
+		SpringApplication.run(SpringDocTestApp.class, args);
+	}
+
+	@Bean
+	EvoInflectorLinkRelationProvider relProvider() {
+		return new EvoInflectorLinkRelationProvider();
+	}
+
+}