Merge pull request #1 from springdoc/master

merge changes to the forked repository

Author: hismaili

.github/workflows/codeql-analysis.yml

@@ -20,4 +20,4 @@ deploy:
   script: mvn deploy -DskipTests --settings settings.xml
   on:
     branch: master
-  
+  

.travis.yml

@@ -13,7 +13,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>2.4.0-M4</version>
+		<version>2.4.0-RC1</version>
 	</parent>
 
 	<licenses>
@@ -25,9 +25,9 @@
 
 	<developers>
 		<developer>
-			<name>Badr NASS</name>
+			<name>Badr NASS LAHSEN</name>
 			<email>[email protected]</email>
-			<organization>BADR</organization>
+			<organization>springdoc</organization>
 			<organizationUrl>https://springdoc.github.io/springdoc-openapi/
 			</organizationUrl>
 		</developer>
@@ -69,7 +69,7 @@
 		<maven-release-plugin.version>2.5.3</maven-release-plugin.version>
 		<nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
 		<swagger-api.version>2.1.5</swagger-api.version>
-		<swagger-ui.version>3.35.2</swagger-ui.version>
+		<swagger-ui.version>3.36.1</swagger-ui.version>
 		<spring-security-oauth2.version>2.3.8.RELEASE</spring-security-oauth2.version>
 		<classgraph.version>4.8.69</classgraph.version>
 		<webjars-locator-core.version>0.45</webjars-locator-core.version>
@@ -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>

CODE_OF_CONDUCT.adoc renamed to CODE_OF_CONDUCT.md

@@ -66,13 +66,13 @@
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springdoc.core.AbstractRequestBuilder;
+import org.springdoc.core.AbstractRequestService;
 import org.springdoc.core.ActuatorProvider;
-import org.springdoc.core.GenericParameterBuilder;
-import org.springdoc.core.GenericResponseBuilder;
+import org.springdoc.core.GenericParameterService;
+import org.springdoc.core.GenericResponseService;
 import org.springdoc.core.MethodAttributes;
-import org.springdoc.core.OpenAPIBuilder;
-import org.springdoc.core.OperationBuilder;
+import org.springdoc.core.OpenAPIService;
+import org.springdoc.core.OperationService;
 import org.springdoc.core.SpringDocConfigProperties;
 import org.springdoc.core.SpringDocConfigProperties.GroupConfig;
 import org.springdoc.core.annotations.RouterOperations;
@@ -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;
 
 /**
@@ -119,12 +120,12 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	/**
 	 * The Open api builder.
 	 */
-	protected OpenAPIBuilder openAPIBuilder;
+	protected OpenAPIService openAPIService;
 
 	/**
 	 * The open api builder object factory.
 	 */
-	private final ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory;
+	private final ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory;
 
 	/**
 	 * The Spring doc config properties.
@@ -139,17 +140,17 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	/**
 	 * The Request builder.
 	 */
-	private final AbstractRequestBuilder requestBuilder;
+	private final AbstractRequestService requestBuilder;
 
 	/**
 	 * The Response builder.
 	 */
-	private final GenericResponseBuilder responseBuilder;
+	private final GenericResponseService responseBuilder;
 
 	/**
 	 * The Operation parser.
 	 */
-	private final OperationBuilder operationParser;
+	private final OperationService operationParser;
 
 	/**
 	 * The Open api customisers.
@@ -184,17 +185,17 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 * @param springDocConfigProperties the spring doc config properties
 	 * @param actuatorProvider the actuator provider
 	 */
-	protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory,
-			AbstractRequestBuilder requestBuilder,
-			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
+	protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
+			AbstractRequestService requestBuilder,
+			GenericResponseService responseBuilder, OperationService operationParser,
 			Optional<List<OperationCustomizer>> operationCustomizers,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers,
 			SpringDocConfigProperties springDocConfigProperties,
 			Optional<ActuatorProvider> actuatorProvider) {
 		super();
 		this.groupName = Objects.requireNonNull(groupName, "groupName");
 		this.openAPIBuilderObjectFactory = openAPIBuilderObjectFactory;
-		this.openAPIBuilder = openAPIBuilderObjectFactory.getObject();
+		this.openAPIService = openAPIBuilderObjectFactory.getObject();
 		this.requestBuilder = requestBuilder;
 		this.responseBuilder = responseBuilder;
 		this.operationParser = operationParser;
@@ -251,44 +252,44 @@ public static void addHiddenRestControllers(String... classes) {
 	 */
 	protected synchronized OpenAPI getOpenApi() {
 		OpenAPI openApi;
-		if (openAPIBuilder.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
+		if (openAPIService.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
 			Instant start = Instant.now();
-			openAPIBuilder.build();
-			Map<String, Object> mappingsMap = openAPIBuilder.getMappingsMap().entrySet().stream()
+			openAPIService.build();
+			Map<String, Object> mappingsMap = openAPIService.getMappingsMap().entrySet().stream()
 					.filter(controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(),
 							Hidden.class) == null))
 					.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getClass()))
 					.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
 
-			Map<String, Object> findControllerAdvice = openAPIBuilder.getControllerAdviceMap();
+			Map<String, Object> findControllerAdvice = openAPIService.getControllerAdviceMap();
 			// calculate generic responses
-			openApi = openAPIBuilder.getCalculatedOpenAPI();
+			openApi = openAPIService.getCalculatedOpenAPI();
 			if (springDocConfigProperties.isOverrideWithGenericResponse() && !CollectionUtils.isEmpty(findControllerAdvice)) {
 				if (!CollectionUtils.isEmpty(mappingsMap))
 					findControllerAdvice.putAll(mappingsMap);
 				responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice);
 			}
 			getPaths(mappingsMap);
 			if (!CollectionUtils.isEmpty(openApi.getServers()))
-				openAPIBuilder.setServersPresent(true);
-			openAPIBuilder.updateServers(openApi);
+				openAPIService.setServersPresent(true);
+			openAPIService.updateServers(openApi);
 
 			if (springDocConfigProperties.isRemoveBrokenReferenceDefinitions())
 				this.removeBrokenReferenceDefinitions(openApi);
 
 			// run the optional customisers
 			openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
 
-			openAPIBuilder.setCachedOpenAPI(openApi);
-			openAPIBuilder.resetCalculatedOpenAPI();
+			openAPIService.setCachedOpenAPI(openApi);
+			openAPIService.resetCalculatedOpenAPI();
 
 			LOGGER.info("Init duration for springdoc-openapi is: {} ms",
 					Duration.between(start, Instant.now()).toMillis());
 		}
 		else {
-			if (!CollectionUtils.isEmpty(openAPIBuilder.getCachedOpenAPI().getServers()))
-				openAPIBuilder.setServersPresent(true);
-			openApi = openAPIBuilder.updateServers(openAPIBuilder.getCachedOpenAPI());
+			if (!CollectionUtils.isEmpty(openAPIService.getCachedOpenAPI().getServers()))
+				openAPIService.setServersPresent(true);
+			openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI());
 		}
 		return openApi;
 	}
@@ -315,7 +316,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 		String[] headers = routerOperation.getHeaders();
 		Map<String, String> queryParams = routerOperation.getQueryParams();
 
-		OpenAPI openAPI = openAPIBuilder.getCalculatedOpenAPI();
+		OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
 		Components components = openAPI.getComponents();
 		Paths paths = openAPI.getPaths();
 
@@ -361,7 +362,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 			fillParametersList(operation, queryParams, methodAttributes);
 
 			// compute tags
-			operation = openAPIBuilder.buildTags(handlerMethod, operation, openAPI);
+			operation = openAPIService.buildTags(handlerMethod, operation, openAPI);
 
 			io.swagger.v3.oas.annotations.parameters.RequestBody requestBodyDoc = AnnotatedElementUtils.findMergedAnnotation(method,
 					io.swagger.v3.oas.annotations.parameters.RequestBody.class);
@@ -411,7 +412,7 @@ private void buildCallbacks(OpenAPI openAPI, MethodAttributes methodAttributes,
 	 * @param routerOperationList the router operation list
 	 */
 	protected void calculatePath(List<RouterOperation> routerOperationList) {
-		ApplicationContext applicationContext = openAPIBuilder.getContext();
+		ApplicationContext applicationContext = openAPIService.getContext();
 		if (!CollectionUtils.isEmpty(routerOperationList)) {
 			Collections.sort(routerOperationList);
 			for (RouterOperation routerOperation : routerOperationList) {
@@ -464,7 +465,7 @@ protected void calculatePath(RouterOperation routerOperation) {
 		String[] headers = routerOperation.getHeaders();
 		Map<String, String> queryParams = routerOperation.getQueryParams();
 
-		OpenAPI openAPI = openAPIBuilder.getCalculatedOpenAPI();
+		OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
 		Paths paths = openAPI.getPaths();
 		Map<HttpMethod, Operation> operationMap = null;
 		if (paths.containsKey(operationPath)) {
@@ -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 = openAPIBuilder.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);
+			}
 		}
 	}
 
@@ -839,7 +848,7 @@ private void fillParametersList(Operation operation, Map<String, String> queryPa
 		List<Parameter> parametersList = operation.getParameters();
 		if (parametersList == null)
 			parametersList = new ArrayList<>();
-		Collection<Parameter> headersMap = AbstractRequestBuilder.getHeaders(methodAttributes, new LinkedHashMap<>());
+		Collection<Parameter> headersMap = AbstractRequestService.getHeaders(methodAttributes, new LinkedHashMap<>());
 		parametersList.addAll(headersMap);
 		if (!CollectionUtils.isEmpty(queryParams)) {
 			for (Map.Entry<String, String> entry : queryParams.entrySet()) {
@@ -848,7 +857,7 @@ private void fillParametersList(Operation operation, Map<String, String> queryPa
 				parameter.setSchema(new StringSchema()._default(entry.getValue()));
 				parameter.setRequired(true);
 				parameter.setIn(ParameterIn.QUERY.toString());
-				GenericParameterBuilder.mergeParameter(parametersList, parameter);
+				GenericParameterService.mergeParameter(parametersList, parameter);
 			}
 			operation.setParameters(parametersList);
 		}
@@ -992,8 +1001,8 @@ else if (existingOperation != null) {
 	 * Init open api builder.
 	 */
 	protected void initOpenAPIBuilder() {
-		if (openAPIBuilder.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
-			openAPIBuilder = openAPIBuilderObjectFactory.getObject();
+		if (openAPIService.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
+			openAPIService = openAPIBuilderObjectFactory.getObject();
 		}
 	}