Merge branch 'routerfunction-attributes2' for #891

Author: bnasslahsen

pom.xml

@@ -244,6 +244,29 @@
 		</profile>
 	</profiles>
 	<repositories>
+		<repository>
+			<id>central</id>
+			<url>https://repo.maven.apache.org/maven2</url>
+			<snapshots>
+				<enabled>false</enabled>
+			</snapshots>
+		</repository>
+		<repository>
+			<id>spring-release</id>
+			<name>Spring release</name>
+			<url>https://repo.spring.io/release</url>
+			<snapshots>
+				<enabled>false</enabled>
+			</snapshots>
+		</repository>
+		<repository>
+			<id>spring-snapshot</id>
+			<name>Spring Snapshots</name>
+			<url>https://repo.spring.io/snapshot</url>
+			<snapshots>
+				<enabled>true</enabled>
+			</snapshots>
+		</repository>
 		<repository>
 			<id>spring-milestone</id>
 			<name>Spring Milestone</name>

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

@@ -93,6 +93,7 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
 
+import static org.springdoc.core.Constants.OPERATION_ATTRIBUTE;
 import static org.springdoc.core.converters.SchemaPropertyDeprecatingConverter.isDeprecated;
 
 /**
@@ -515,22 +516,30 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
 	 * @param routerFunctionVisitor the router function visitor
 	 */
 	protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVisitor routerFunctionVisitor) {
-		List<org.springdoc.core.annotations.RouterOperation> routerOperationList = new ArrayList<>();
-		ApplicationContext applicationContext = openAPIService.getContext();
-		RouterOperations routerOperations = applicationContext.findAnnotationOnBean(beanName, RouterOperations.class);
-		if (routerOperations == null) {
-			org.springdoc.core.annotations.RouterOperation routerOperation = applicationContext.findAnnotationOnBean(beanName, org.springdoc.core.annotations.RouterOperation.class);
-			if (routerOperation != null)
-				routerOperationList.add(routerOperation);
+		boolean withRouterOperation = routerFunctionVisitor.getRouterFunctionDatas().stream()
+				.anyMatch(routerFunctionData -> routerFunctionData.getAttributes().containsKey(OPERATION_ATTRIBUTE));
+		if (withRouterOperation) {
+			List<RouterOperation> operationList = routerFunctionVisitor.getRouterFunctionDatas().stream().map(RouterOperation::new).collect(Collectors.toList());
+			calculatePath(operationList);
 		}
-		else
-			routerOperationList.addAll(Arrays.asList(routerOperations.value()));
-		if (routerOperationList.size() == 1)
-			calculatePath(routerOperationList.stream().map(routerOperation -> new RouterOperation(routerOperation, routerFunctionVisitor.getRouterFunctionDatas().get(0))).collect(Collectors.toList()));
 		else {
-			List<RouterOperation> operationList = routerOperationList.stream().map(RouterOperation::new).collect(Collectors.toList());
-			mergeRouters(routerFunctionVisitor.getRouterFunctionDatas(), operationList);
-			calculatePath(operationList);
+			List<org.springdoc.core.annotations.RouterOperation> routerOperationList = new ArrayList<>();
+			ApplicationContext applicationContext = openAPIService.getContext();
+			RouterOperations routerOperations = applicationContext.findAnnotationOnBean(beanName, RouterOperations.class);
+			if (routerOperations == null) {
+				org.springdoc.core.annotations.RouterOperation routerOperation = applicationContext.findAnnotationOnBean(beanName, org.springdoc.core.annotations.RouterOperation.class);
+				if (routerOperation != null)
+					routerOperationList.add(routerOperation);
+			}
+			else
+				routerOperationList.addAll(Arrays.asList(routerOperations.value()));
+			if (routerOperationList.size() == 1)
+				calculatePath(routerOperationList.stream().map(routerOperation -> new RouterOperation(routerOperation, routerFunctionVisitor.getRouterFunctionDatas().get(0))).collect(Collectors.toList()));
+			else {
+				List<RouterOperation> operationList = routerOperationList.stream().map(RouterOperation::new).collect(Collectors.toList());
+				mergeRouters(routerFunctionVisitor.getRouterFunctionDatas(), operationList);
+				calculatePath(operationList);
+			}
 		}
 	}
 

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

@@ -1,3 +1,26 @@
+/*
+ *
+ *
+ *  *
+ *  *  *
+ *  *  *  * 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;
 
 /**

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

@@ -270,6 +270,11 @@ public final class Constants {
 	 */
 	public static final String CSRF_DEFAULT_HEADER_NAME= "X-XSRF-TOKEN";
 
+	/**
+	 * The constant OPERATION_ATTRIBUTE.
+	 */
+	public static final String OPERATION_ATTRIBUTE = Constants.class.getName() + ".operation";
+
 	/**
 	 * Instantiates a new Constants.
 	 */

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

@@ -1,3 +1,26 @@
+/*
+ *
+ *
+ *  *
+ *  *  *
+ *  *  *  * 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.core;
 
 import java.util.List;

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

@@ -1,3 +1,26 @@
+/*
+ *
+ *
+ *  *
+ *  *  *
+ *  *  *  * 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.core.customizers;
 
 import java.util.List;

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

@@ -1,3 +1,26 @@
+/*
+ *
+ *
+ *  *
+ *  *  *
+ *  *  *  * 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.core.customizers;
 
 import org.springframework.core.MethodParameter;

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

@@ -22,7 +22,9 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import org.apache.commons.lang3.StringUtils;
@@ -76,6 +78,11 @@ public class AbstractRouterFunctionVisitor {
 	 */
 	protected RouterFunctionData routerFunctionData;
 
+	/**
+	 * The Attributes.
+	 */
+	protected Map<String,Object> attributes = new LinkedHashMap<>();
+
 	/**
 	 * Method.
 	 *
@@ -223,18 +230,18 @@ protected void computeNested() {
 			List<RouterFunctionData> routerFunctionDatasClone = new ArrayList<>();
 			for (RouterFunctionData functionData : routerFunctionDatas) {
 				for (String nestedOrPath : nestedOrPaths) {
-					RouterFunctionData routerFunctionDataClone = new RouterFunctionData(nestedOrPath + functionData.getPath(), functionData.getConsumes(), functionData.getProduces(), functionData.getHeaders(), functionData.getQueryParams(), functionData.getMethods());
+					RouterFunctionData routerFunctionDataClone = new RouterFunctionData(nestedOrPath , functionData);
 					routerFunctionDatasClone.add(routerFunctionDataClone);
 				}
 			}
 			this.routerFunctionDatas = routerFunctionDatasClone;
 			nestedAndPaths.clear();
 		}
-		if (!nestedAcceptHeaders.isEmpty()){
+		if (!nestedAcceptHeaders.isEmpty()) {
 			routerFunctionDatas.forEach(existingRouterFunctionData -> existingRouterFunctionData.addProduces(nestedAcceptHeaders));
 			nestedAcceptHeaders.clear();
 		}
-		if (!nestedContentTypeHeaders.isEmpty()){
+		if (!nestedContentTypeHeaders.isEmpty()) {
 			routerFunctionDatas.forEach(existingRouterFunctionData -> existingRouterFunctionData.addConsumes(nestedContentTypeHeaders));
 			nestedContentTypeHeaders.clear();
 		}
@@ -284,4 +291,22 @@ private void calculateAccept(String value) {
 		}
 	}
 
+	/**
+	 * Route.
+	 */
+	protected void route() {
+		this.routerFunctionData = new RouterFunctionData();
+		routerFunctionDatas.add(this.routerFunctionData);
+		this.routerFunctionData.addAttributes(this.attributes);
+	}
+
+	/**
+	 * Attributes.
+	 *
+	 * @param map the map
+	 */
+	public void attributes(Map<String, Object> map) {
+		this.attributes = map;
+	}
+
 }

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

@@ -22,7 +22,7 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -63,13 +63,18 @@ public class RouterFunctionData {
 	/**
 	 * The Query params.
 	 */
-	private Map<String, String> queryParams = new HashMap<>();
+	private Map<String, String> queryParams = new LinkedHashMap<>();
 
 	/**
 	 * The Methods.
 	 */
 	private RequestMethod[] methods;
 
+	/**
+	 * The Attributes.
+	 */
+	private Map<String,Object> attributes = new LinkedHashMap<>();
+
 	/**
 	 * Instantiates a new Router function data.
 	 */
@@ -78,20 +83,17 @@ public RouterFunctionData() { }
 	/**
 	 * Instantiates a new Router function data.
 	 *
-	 * @param path the path
-	 * @param consumes the consumes
-	 * @param produces the produces
-	 * @param headers the headers
-	 * @param queryParams the query params
-	 * @param methods the methods
+	 * @param nestedOrPath the nested or path
+	 * @param functionData the function data
 	 */
-	public RouterFunctionData(String path, String[] consumes, String[] produces, String[] headers, Map<String, String> queryParams, RequestMethod[] methods) {
-		this.path = path;
-		this.consumes = Arrays.asList(consumes);
-		this.produces = Arrays.asList(produces);
-		this.headers = Arrays.asList(headers);
-		this.queryParams = queryParams;
-		this.methods = methods;
+	public RouterFunctionData(String nestedOrPath, RouterFunctionData functionData) {
+		this.path = nestedOrPath + functionData.getPath();
+		this.consumes = Arrays.asList(functionData.getConsumes());
+		this.produces = Arrays.asList(functionData.getProduces());
+		this.headers = Arrays.asList(functionData.getHeaders());
+		this.queryParams = functionData.getQueryParams();
+		this.methods = functionData.getMethods();
+		this.attributes = functionData.getAttributes();
 	}
 
 	/**
@@ -273,4 +275,22 @@ private RequestMethod getRequestMethod(HttpMethod httpMethod) {
 		}
 		return requestMethod;
 	}
+
+	/**
+	 * Gets attributes.
+	 *
+	 * @return the attributes
+	 */
+	public Map<String, Object> getAttributes() {
+		return attributes;
+	}
+
+	/**
+	 * Add attributes.
+	 *
+	 * @param attributes the attributes
+	 */
+	public void addAttributes(Map<String, Object> attributes) {
+		this.attributes.putAll(attributes);
+	}
 }