MultipleOpenApiResource issue?. Fixes #771

Author: bnasslahsen

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

@@ -0,0 +1,77 @@
+/*
+ *
+ *  * 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 org.springdoc.api;
+
+import java.util.UUID;
+
+/**
+ * The type Error message.
+ */
+public class ErrorMessage {
+
+	private UUID id;
+
+	private String message;
+
+	/**
+	 * Instantiates a new Error message.
+	 *
+	 * @param message the message
+	 */
+	public ErrorMessage(String message) {
+		this.id = UUID.randomUUID();
+		this.message = message;
+	}
+
+	/**
+	 * Gets id.
+	 *
+	 * @return the id
+	 */
+	public UUID getId() {
+		return id;
+	}
+
+	/**
+	 * Sets id.
+	 *
+	 * @param id the id
+	 */
+	public void setId(UUID id) {
+		this.id = id;
+	}
+
+	/**
+	 * Gets message.
+	 *
+	 * @return the message
+	 */
+	public String getMessage() {
+		return message;
+	}
+
+	/**
+	 * Sets message.
+	 *
+	 * @param message the message
+	 */
+	public void setMessage(String message) {
+		this.message = message;
+	}
+}

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

@@ -0,0 +1,17 @@
+package org.springdoc.api;
+
+/**
+ * The type Open api resource not found exception.
+ * @author bnasslahsen
+ */
+public class OpenApiResourceNotFoundException extends RuntimeException {
+
+	/**
+	 * Instantiates a new Open api resource not found exception.
+	 *
+	 * @param message the message
+	 */
+	public OpenApiResourceNotFoundException(String message) {
+		super(message);
+	}
+}

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

@@ -27,10 +27,13 @@
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.swagger.v3.core.converter.ModelConverter;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.Schema;
+import org.springdoc.api.ErrorMessage;
+import org.springdoc.api.OpenApiResourceNotFoundException;
 import org.springdoc.core.converters.AdditionalModelsConverter;
 import org.springdoc.core.converters.FileSupportConverter;
 import org.springdoc.core.converters.ModelConverterRegistrar;
@@ -55,6 +58,12 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
 
 import static org.springdoc.core.Constants.SPRINGDOC_DEPRECATING_CONVERTER_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
@@ -313,4 +322,24 @@ static BeanFactoryPostProcessor springdocBeanFactoryPostProcessor2() {
 		return SpringdocBeanFactoryConfigurer::initBeanFactoryPostProcessor;
 	}
 
+	/**
+	 * The type Open api resource advice.
+	 */
+	@RestControllerAdvice
+	@Hidden
+	class OpenApiResourceAdvice {
+		/**
+		 * Handle no handler found response entity.
+		 *
+		 * @param e the e
+		 * @param request the request
+		 * @return the response entity
+		 */
+		@ExceptionHandler(OpenApiResourceNotFoundException.class)
+		@ResponseStatus(HttpStatus.NOT_FOUND)
+		public ResponseEntity<ErrorMessage> handleNoHandlerFound(OpenApiResourceNotFoundException e, WebRequest request) {
+			return ResponseEntity.status(HttpStatus.NOT_FOUND).body(new ErrorMessage(e.getMessage()));
+		}
+	}
+
 }

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

@@ -84,7 +84,7 @@ public static void addResponseTypeToIgnore(Class<?> cls) {
 	/**
 	 * Is response type wrapper boolean.
 	 *
-	 * @param rawClass the raw class
+	 * @param rawClass the raw class 
 	 * @return the boolean
 	 */
 	public static boolean isResponseTypeWrapper(Class<?> rawClass) {
@@ -94,7 +94,7 @@ public static boolean isResponseTypeWrapper(Class<?> rawClass) {
 	/**
 	 * Is response type to ignore boolean.
 	 *
-	 * @param rawClass the raw class
+	 * @param rawClass the raw class 
 	 * @return the boolean
 	 */
 	public static boolean isResponseTypeToIgnore(Class<?> rawClass) {
@@ -126,7 +126,7 @@ public static void removeResponseTypeToIgnore(Class<?> classes) {
 	/**
 	 * Is flux type wrapper boolean.
 	 *
-	 * @param rawClass the raw class
+	 * @param rawClass the raw class 
 	 * @return the boolean
 	 */
 	public static boolean isFluxTypeWrapper(Class<?> rawClass) {

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

@@ -34,8 +34,8 @@ public class DefaultPageable extends Pageable {
 	/**
 	 * Instantiates a new Default pageable.
 	 *
-	 * @param page the page
-	 * @param size the size
+	 * @param page the page 
+	 * @param size the size 
 	 * @param sort the sort
 	 */
 	public DefaultPageable(int page, int size, List<String> sort) {

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

@@ -61,8 +61,8 @@ public class Pageable {
 	/**
 	 * Instantiates a new Pageable.
 	 *
-	 * @param page the page
-	 * @param size the size
+	 * @param page the page 
+	 * @param size the size 
 	 * @param sort the sort
 	 */
 	public Pageable(int page, int size, List<String> sort) {

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/ParameterCustomizer.java

@@ -34,8 +34,8 @@ public interface ParameterCustomizer {
 	/**
 	 * Customize parameter.
 	 *
-	 * @param parameterModel to be customized
-	 * @param methodParameter original parameter from handler method
+	 * @param parameterModel to be customized 
+	 * @param methodParameter original parameter from handler method 
 	 * @return customized parameter
 	 */
 	Parameter customize(Parameter parameterModel, MethodParameter methodParameter);

springdoc-openapi-common/src/main/java/org/springdoc/core/fn/AbstractRouterFunctionVisitor.java

@@ -64,7 +64,7 @@ public void path(String pattern) {
 	/**
 	 * Header.
 	 *
-	 * @param name the name
+	 * @param name the name 
 	 * @param value the value
 	 */
 	public void header(String name, String value) {
@@ -88,7 +88,7 @@ public List<RouterFunctionData> getRouterFunctionDatas() {
 	/**
 	 * Query param.
 	 *
-	 * @param name the name
+	 * @param name the name 
 	 * @param value the value
 	 */
 	public void queryParam(String name, String value) {
@@ -107,7 +107,7 @@ public void pathExtension(String extension) {
 	/**
 	 * Param.
 	 *
-	 * @param name the name
+	 * @param name the name 
 	 * @param value the value
 	 */
 	public void param(String name, String value) {

springdoc-openapi-common/src/main/java/org/springdoc/core/fn/RouterFunctionData.java

@@ -99,7 +99,7 @@ public Map<String, String> getQueryParams() {
 	/**
 	 * Add query params.
 	 *
-	 * @param name the name
+	 * @param name the name 
 	 * @param value the value
 	 */
 	public void addQueryParams(String name, String value) {

springdoc-openapi-common/src/main/java/org/springdoc/core/fn/RouterOperation.java

@@ -112,7 +112,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 	/**
 	 * Instantiates a new Router operation.
 	 *
-	 * @param routerOperationAnnotation the router operation annotation
+	 * @param routerOperationAnnotation the router operation annotation 
 	 * @param routerFunctionData the router function data
 	 */
 	public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOperationAnnotation, RouterFunctionData routerFunctionData) {
@@ -131,7 +131,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 	/**
 	 * Instantiates a new Router operation.
 	 *
-	 * @param path the path
+	 * @param path the path 
 	 * @param methods the methods
 	 */
 	public RouterOperation(String path, RequestMethod[] methods) {

springdoc-openapi-common/src/main/java/org/springdoc/ui/AbstractSwaggerIndexTransformer.java

@@ -58,8 +58,8 @@ public class AbstractSwaggerIndexTransformer {
 	/**
 	 * Instantiates a new Abstract swagger index transformer.
 	 *
-	 * @param swaggerUiConfig the swagger ui config
-	 * @param swaggerUiOAuthProperties the swagger ui o auth properties
+	 * @param swaggerUiConfig the swagger ui config 
+	 * @param swaggerUiOAuthProperties the swagger ui o auth properties 
 	 * @param objectMapper the object mapper
 	 */
 	public AbstractSwaggerIndexTransformer(SwaggerUiConfigProperties swaggerUiConfig, SwaggerUiOAuthProperties swaggerUiOAuthProperties, ObjectMapper objectMapper) {
@@ -71,8 +71,8 @@ public AbstractSwaggerIndexTransformer(SwaggerUiConfigProperties swaggerUiConfig
 	/**
 	 * Add init oauth string.
 	 *
-	 * @param html the html
-	 * @return the string
+	 * @param html the html 
+	 * @return the string 
 	 * @throws JsonProcessingException the json processing exception
 	 */
 	protected String addInitOauth(String html) throws JsonProcessingException {
@@ -87,8 +87,8 @@ protected String addInitOauth(String html) throws JsonProcessingException {
 	/**
 	 * Read fully as string string.
 	 *
-	 * @param inputStream the input stream
-	 * @return the string
+	 * @param inputStream the input stream 
+	 * @return the string 
 	 * @throws IOException the io exception
 	 */
 	protected String readFullyAsString(InputStream inputStream)
@@ -105,18 +105,30 @@ protected String readFullyAsString(InputStream inputStream)
 	/**
 	 * Overwrite swagger default url string.
 	 *
-	 * @param html the html
+	 * @param html the html 
 	 * @return the string
 	 */
 	protected String overwriteSwaggerDefaultUrl(String html) {
 		return html.replace(Constants.SWAGGER_UI_DEFAULT_URL, StringUtils.EMPTY);
 	}
 
+	/**
+	 * Has default transformations boolean.
+	 *
+	 * @return the boolean
+	 */
 	protected boolean hasDefaultTransformations() {
 		boolean oauth2Configured = !CollectionUtils.isEmpty(swaggerUiOAuthProperties.getConfigParameters());
 		return oauth2Configured || swaggerUiConfig.isDisableSwaggerDefaultUrl();
 	}
 
+	/**
+	 * Default transformations string.
+	 *
+	 * @param inputStream the input stream 
+	 * @return the string 
+	 * @throws IOException the io exception
+	 */
 	protected String defaultTransformations(InputStream inputStream) throws IOException {
 		String html = readFullyAsString(inputStream);
 		if (!CollectionUtils.isEmpty(swaggerUiOAuthProperties.getConfigParameters())) {

springdoc-openapi-common/src/main/java/org/springdoc/ui/AbstractSwaggerWelcome.java

@@ -58,8 +58,8 @@ public abstract class AbstractSwaggerWelcome implements InitializingBean {
 	/**
 	 * Instantiates a new Abstract swagger welcome.
 	 *
-	 * @param swaggerUiConfig the swagger ui config
-	 * @param springDocConfigProperties the spring doc config properties
+	 * @param swaggerUiConfig the swagger ui config 
+	 * @param springDocConfigProperties the spring doc config properties 
 	 * @param swaggerUiConfigParameters the swagger ui config parameters
 	 */
 	public AbstractSwaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties, SwaggerUiConfigParameters swaggerUiConfigParameters) {
@@ -77,8 +77,8 @@ public void afterPropertiesSet() {
 	/**
 	 * Build url string.
 	 *
-	 * @param contextPath the context path
-	 * @param docsUrl the docs url
+	 * @param contextPath the context path 
+	 * @param docsUrl the docs url 
 	 * @return the string
 	 */
 	protected String buildUrl(String contextPath, final String docsUrl) {
@@ -91,7 +91,7 @@ protected String buildUrl(String contextPath, final String docsUrl) {
 	/**
 	 * Build config url.
 	 *
-	 * @param contextPath the context path
+	 * @param contextPath the context path 
 	 * @param uriComponentsBuilder the uri components builder
 	 */
 	protected void buildConfigUrl(String contextPath, UriComponentsBuilder uriComponentsBuilder) {
@@ -116,7 +116,7 @@ protected void buildConfigUrl(String contextPath, UriComponentsBuilder uriCompon
 	/**
 	 * Gets uri components builder.
 	 *
-	 * @param sbUrl the sb url
+	 * @param sbUrl the sb url 
 	 * @return the uri components builder
 	 */
 	protected UriComponentsBuilder getUriComponentsBuilder(String sbUrl) {

springdoc-openapi-common/src/main/java/org/springdoc/ui/SpringDocUIException.java

@@ -29,7 +29,7 @@ public class SpringDocUIException extends RuntimeException {
 	/**
 	 * Instantiates a new Spring doc ui exception.
 	 *
-	 * @param message the message
+	 * @param message the message 
 	 * @param cause the cause
 	 */
 	public SpringDocUIException(String message, Throwable cause) {