Merge branch 'master' of https://github.com/springdoc/springdoc-openapi into actuator-description

� Conflicts:
�	springdoc-openapi-webmvc-core/src/main/java/org/springdoc/api/MultipleOpenApiResource.java
�	springdoc-openapi-webmvc-core/src/main/java/org/springdoc/api/OpenApiResource.java
�	springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app68/SpringDocApp68Test.java

Author: devnied

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased] -
+### Added
+- Support for pathsToMatch and packagesToScan to work in spinal-case as well. Fixes #338
+## Fixed
+- Fixes springdoc.swagger-ui.url property #339
+
+## [1.2.26] -
+### Added
+- Make springdoc cache configurable #331
+### Fixed
+- Multiple paths in controller and DeleteMapping generates incorrect Request Body #334
+
 ## [1.2.25] -
 ### Fixed
 - Fix double registration of model converters when grouped api is used #324

README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.org/springdoc/springdoc-openapi.svg?branch=master)](https://travis-ci.org/springdoc/springdoc-openapi)
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=springdoc_springdoc-openapi&metric=alert_status)](https://sonarcloud.io/dashboard?id=springdoc_springdoc-openapi)
+[![Known Vulnerabilities](https://snyk.io/test/github/springdoc/springdoc-openapi.git/badge.svg)](https://snyk.io/test/github/springdoc/springdoc-openapi.git)
 
 ![Octocat](https://springdoc.github.io/springdoc-openapi-demos/images/springdoc-openapi.png)
 

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.springdoc</groupId>
     <artifactId>springdoc-openapi</artifactId>
-    <version>1.2.26-SNAPSHOT</version>
+    <version>1.2.27-SNAPSHOT</version>
     <packaging>pom</packaging>
     <name>Spring openapi documentation generator</name>
     <description>Spring openapi documentation generator</description>
@@ -70,6 +70,7 @@
         <swagger-api.version>2.1.0</swagger-api.version>
         <swagger-ui.version>3.24.0</swagger-ui.version>
         <webjars-locator.version>0.38</webjars-locator.version>
+        <spring-security-oauth2.version>2.3.5.RELEASE</spring-security-oauth2.version>
     </properties>
 
     <dependencyManagement>
@@ -101,6 +102,11 @@
                 <artifactId>webjars-locator</artifactId>
                 <version>${webjars-locator.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.springframework.security.oauth</groupId>
+                <artifactId>spring-security-oauth2</artifactId>
+                <version>${spring-security-oauth2.version}</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <dependencies>

springdoc-openapi-common/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.springdoc</groupId>
         <artifactId>springdoc-openapi</artifactId>
-        <version>1.2.26-SNAPSHOT</version>
+        <version>1.2.27-SNAPSHOT</version>
     </parent>
     <dependencies>
         <dependency>

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

@@ -29,8 +29,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import static org.springdoc.core.Constants.SPRINGDOC_PACKAGES_TO_SCAN;
-import static org.springdoc.core.Constants.SPRINGDOC_PATHS_TO_MATCH;
+import static org.springdoc.core.Constants.*;
 
 public abstract class AbstractOpenApiResource {
 
@@ -46,6 +45,8 @@ public abstract class AbstractOpenApiResource {
     private List<String> packagesToScan;
     @Value(SPRINGDOC_PATHS_TO_MATCH)
     private List<String> pathsToMatch;
+    @Value(SPRINGDOC_CACHE_DISABLED_VALUE)
+    private boolean cacheDisabled;
 
     protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
                                       AbstractResponseBuilder responseBuilder, OperationBuilder operationParser,
@@ -60,7 +61,7 @@ protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequest
 
     protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
                                       AbstractResponseBuilder responseBuilder, OperationBuilder operationParser,
-                                      Optional<List<OpenApiCustomiser>> openApiCustomisers, List<String> pathsToMatch, List<String> packagesToScan) {
+                                      Optional<List<OpenApiCustomiser>> openApiCustomisers, List<String> pathsToMatch, List<String> packagesToScan,boolean cacheDisabled) {
         super();
         this.openAPIBuilder = openAPIBuilder;
         this.requestBuilder = requestBuilder;
@@ -69,11 +70,12 @@ protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequest
         this.openApiCustomisers = openApiCustomisers;
         this.pathsToMatch = pathsToMatch;
         this.packagesToScan = packagesToScan;
+        this.cacheDisabled=cacheDisabled;
     }
 
     protected synchronized OpenAPI getOpenApi() {
         OpenAPI openApi;
-        if (!computeDone) {
+        if (!computeDone || cacheDisabled) {
             Instant start = Instant.now();
             openAPIBuilder.build();
             Map<String, Object> restControllersMap = openAPIBuilder.getRestControllersMap();

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

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.oas.annotations.Hidden;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.Schema;
@@ -174,7 +175,7 @@ protected Parameter customiseParameter(Parameter parameter, ParameterInfo parame
     }
 
     protected boolean isParamToIgnore(java.lang.reflect.Parameter parameter) {
-        if (parameter.isAnnotationPresent(PathVariable.class)) {
+        if (parameter.isAnnotationPresent(PathVariable.class) || parameter.isAnnotationPresent(RequestParam.class)) {
             return false;
         }
         return parameterBuilder.isAnnotationToIgnore(parameter) || PARAM_TYPES_TO_IGNORE.contains(parameter.getType()) || (AnnotationUtils.findAnnotation(parameter.getType(), Hidden.class) != null);
@@ -224,9 +225,8 @@ private Parameter buildParams(ParameterInfo parameterInfo, Components components
             requestInfo = new RequestInfo(ParameterType.PATH_PARAM, pathVar.value(), Boolean.TRUE, null);
             parameter = buildParam(parameterInfo, components, requestInfo, jsonView);
         }
-
         // By default
-        if (RequestMethod.GET.equals(requestMethod)) {
+        if (RequestMethod.GET.equals(requestMethod) || (parameterInfo.getParameterModel() != null && ParameterIn.PATH.toString().equals(parameterInfo.getParameterModel().getIn()))) {
             parameter = this.buildParam(QUERY_PARAM, components, parameterInfo, Boolean.TRUE, null, jsonView);
         }
 

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

@@ -11,11 +11,19 @@ public final class Constants {
     public static final String SWAGGER_CONFIG_URL = API_DOCS_URL + DEFAULT_PATH_SEPARATOR + SWAGGGER_CONFIG_FILE;
     public static final String DEFAULT_API_DOCS_URL_YAML = API_DOCS_URL + ".yaml";
     public static final String SPRINGDOC_ENABLED = "springdoc.api-docs.enabled";
+    public static final String SPRINGDOC_CACHE_DISABLED = "springdoc.cache.disabled";
+    public static final String SPRINGDOC_CACHE_DISABLED_VALUE= "${" + SPRINGDOC_CACHE_DISABLED + ":false}";
     public static final String SPRINGDOC_SWAGGER_UI_ENABLED = "springdoc.swagger-ui.enabled";
+    public static final String SPRINGDOC_SWAGGER_UI_CONFIG_URL  ="springdoc.swagger-ui.configUrl";
+    public static final String SPRINGDOC_SWAGGER_UI_URL  ="springdoc.swagger-ui.url";
+    public static final String SPRINGDOC_SWAGGER_UI_URL_VALUE  ="${" + SPRINGDOC_SWAGGER_UI_URL + ":#{null}}";
+    public static final String SPRINGDOC_OAUTH2_REDIRECT_URL  ="springdoc.swagger-ui.oauth2RedirectUrl";
+    public static final String SPRINGDOC_OAUTH2_REDIRECT_URL_VALUE  ="${" + SPRINGDOC_OAUTH2_REDIRECT_URL + ":#{null}}";
+    public static final String SPRINGDOC_SWAGGER_UI_CONFIG_URL_VALUE  ="${" + SPRINGDOC_SWAGGER_UI_CONFIG_URL + ":#{null}}";
     public static final String SPRINGDOC_SHOW_ACTUATOR = "springdoc.show-actuator";
     public static final String SPRINGDOC_SHOW_ACTUATOR_VALUE = "${" + SPRINGDOC_SHOW_ACTUATOR + ":false}";
-    public static final String SPRINGDOC_PACKAGES_TO_SCAN = "${springdoc.packagesToScan:#{null}}";
-    public static final String SPRINGDOC_PATHS_TO_MATCH = "${springdoc.pathsToMatch:#{null}}";
+    public static final String SPRINGDOC_PACKAGES_TO_SCAN = "${springdoc.packages-to-scan:#{null}}";
+    public static final String SPRINGDOC_PATHS_TO_MATCH = "${springdoc.paths-to-match:#{null}}";
     public static final String SPRINGDOC_ACTUATOR_TAG = "Actuator";
     public static final String SPRINGDOC_ACTUATOR_DESCRIPTION = "Monitor and interact";
     public static final String SPRINGDOC_ACTUATOR_DOC_URL = "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/";
@@ -37,7 +45,6 @@ public final class Constants {
     public static final String HEAD_METHOD = "head";
     public static final String OPTIONS_METHOD = "options";
     public static final String QUERY_PARAM = "query";
-
     public static final String DEFAULT_DESCRIPTION = "default response";
     public static final String DEFAULT_TITLE = "OpenAPI definition";
     public static final String DEFAULT_VERSION = "v0";

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

@@ -46,26 +46,31 @@ public class OpenAPIBuilder {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(OpenAPIBuilder.class);
     private final OpenAPI openAPI;
+    private boolean isServersPresent = false;
     private final ApplicationContext context;
     private final SecurityParser securityParser;
     private final Map<HandlerMethod, io.swagger.v3.oas.models.tags.Tag> springdocTags = new HashMap<>();
     private String serverBaseUrl;
+    private final Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider;
 
     @SuppressWarnings("WeakerAccess")
-    OpenAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser) {
+    OpenAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider) {
         if (openAPI.isPresent()) {
             this.openAPI = openAPI.get();
             if (this.openAPI.getComponents() == null)
                 this.openAPI.setComponents(new Components());
             if (this.openAPI.getPaths() == null)
                 this.openAPI.setPaths(new Paths());
+            if (!CollectionUtils.isEmpty(this.openAPI.getServers()))
+                this.isServersPresent = true;
         } else {
             this.openAPI = new OpenAPI();
             this.openAPI.setComponents(new Components());
             this.openAPI.setPaths(new Paths());
         }
         this.context = context;
         this.securityParser = securityParser;
+        this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
     }
 
     private static String splitCamelCase(String str) {
@@ -102,9 +107,11 @@ else if (openAPI.getInfo() == null) {
             openAPI.setInfo(infos);
         }
         // default server value
-        if (CollectionUtils.isEmpty(openAPI.getServers())) {
+        if (CollectionUtils.isEmpty(openAPI.getServers()) || !isServersPresent) {
             Server server = new Server().url(serverBaseUrl).description(DEFAULT_SERVER_DESCRIPTION);
-            openAPI.addServersItem(server);
+            List servers = new ArrayList();
+            servers.add(server);
+            openAPI.setServers(servers);
         }
         // add security schemes
         this.calculateSecuritySchemes(openAPI.getComponents());
@@ -201,15 +208,27 @@ private Optional<OpenAPIDefinition> getOpenAPIDefinition() {
 
     private void buildOpenAPIWithOpenAPIDefinition(OpenAPI openAPI, OpenAPIDefinition apiDef) {
         // info
-        AnnotationsUtils.getInfo(apiDef.info()).ifPresent(openAPI::setInfo);
+        Optional<Info> infos = AnnotationsUtils.getInfo(apiDef.info());
+        if (infos.isPresent()) {
+            Info info = infos.get();
+            if (StringUtils.isNotBlank(info.getTitle())) {
+                PropertyResolverUtils propertyResolverUtils = context.getBean(PropertyResolverUtils.class);
+                info.title(propertyResolverUtils.resolve(info.getTitle()));
+            }
+            openAPI.setInfo(info);
+        }
         // OpenApiDefinition security requirements
         securityParser.getSecurityRequirements(apiDef.security()).ifPresent(openAPI::setSecurity);
         // OpenApiDefinition external docs
         AnnotationsUtils.getExternalDocumentation(apiDef.externalDocs()).ifPresent(openAPI::setExternalDocs);
         // OpenApiDefinition tags
         AnnotationsUtils.getTags(apiDef.tags(), false).ifPresent(tags -> openAPI.setTags(new ArrayList<>(tags)));
         // OpenApiDefinition servers
-        openAPI.setServers(AnnotationsUtils.getServers(apiDef.servers()).orElse(null));
+        Optional<List<Server>> optionalServers = AnnotationsUtils.getServers(apiDef.servers());
+        if (optionalServers.isPresent()) {
+            openAPI.setServers(optionalServers.get());
+            this.isServersPresent = true;
+        }
         // OpenApiDefinition extensions
         if (apiDef.extensions().length > 0) {
             openAPI.setExtensions(AnnotationsUtils.getExtensions(apiDef.extensions()));
@@ -313,4 +332,8 @@ public Map<String, Object> getControllerAdviceMap() {
                 controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(), Hidden.class) == null))
                 .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
     }
+
+    public Optional<SecurityOAuth2Provider> getSpringSecurityOAuth2Provider() {
+        return springSecurityOAuth2Provider;
+    }
 }

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

@@ -0,0 +1,10 @@
+package org.springdoc.core;
+
+import java.util.Map;
+
+public interface SecurityOAuth2Provider {
+
+     Map getHandlerMethods();
+
+     Map<String, Object> getFrameworkEndpoints();
+}

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

@@ -6,9 +6,9 @@
 import org.springdoc.core.converters.ObjectNodeConverter;
 import org.springdoc.core.converters.PropertyCustomizingConverter;
 import org.springdoc.core.customizers.PropertyCustomizer;
+import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+import org.springframework.boot.autoconfigure.condition.*;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -18,6 +18,7 @@
 import java.util.List;
 import java.util.Optional;
 
+import static org.springdoc.core.Constants.SPRINGDOC_CACHE_DISABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 
 @Configuration
@@ -45,8 +46,8 @@ IgnoredParameterAnnotationsDefault ignoredParameterAnnotationsDefault() {
     }
 
     @Bean
-    public OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser) {
-        return new OpenAPIBuilder(openAPI, context, securityParser);
+    public OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser,Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider) {
+        return new OpenAPIBuilder(openAPI, context, securityParser,springSecurityOAuth2Provider);
     }
 
     @Bean
@@ -78,4 +79,34 @@ public SecurityParser securityParser(PropertyResolverUtils propertyResolverUtils
         return new SecurityParser(propertyResolverUtils);
     }
 
+    static class ConditionOnCacheOrGroupedOpenApi extends AnyNestedCondition {
+
+        ConditionOnCacheOrGroupedOpenApi() {
+            super(ConfigurationPhase.REGISTER_BEAN);
+        }
+
+        @Bean
+        @ConditionalOnBean(GroupedOpenApi.class)
+        public BeanFactoryPostProcessor beanFactoryPostProcessor1() {
+            return getBeanFactoryPostProcessor();
+        }
+
+        @Bean
+        @ConditionalOnProperty(name = SPRINGDOC_CACHE_DISABLED)
+        @ConditionalOnMissingBean(GroupedOpenApi.class)
+        public BeanFactoryPostProcessor beanFactoryPostProcessor2() {
+            return getBeanFactoryPostProcessor();
+        }
+
+        private BeanFactoryPostProcessor getBeanFactoryPostProcessor() {
+            return beanFactory -> {
+                for (String beanName : beanFactory.getBeanNamesForType(OpenAPIBuilder.class)) {
+                    beanFactory.getBeanDefinition(beanName).setScope("prototype");
+                }
+                for (String beanName : beanFactory.getBeanNamesForType(OpenAPI.class)) {
+                    beanFactory.getBeanDefinition(beanName).setScope("prototype");
+                }
+            };
+        }
+    }
 }