Merge remote-tracking branch 'upstream/master'

Author: m-kay

.travis.yml

@@ -11,7 +11,7 @@ addons:
     organization: "springdoc-openapi"
     token:
       secure: "S5zeA+Vvbe7LG450OAtd5TrBRL8fhaWgJjzAp3RzS797++2xrN92jI74h5NL0MiYBd6NKoWql1WJaMKHCfo/EJ6RdExdw71126B2k061iK54y8pxom+ADFigKgkVzHgnV28uBioC2DIcVvRDk8WkX6IZ9I6C72TzWapXrlCnRkSY1lsfOwvqahTYheaDzRKWN5WoBm8M63IiciMz21SSrdm20fjQeY90EI0EfKn0jjJWL8WKmDa98MeSsJWBwR964ICKRvRq9CGTjTZVhL+D0VYt4tS7kpoN9QatL6SL/octL6jXhgGqnFu8AWRwe1RX7hM9jjDLCkXrz6pr9+t4ts8lo7CcG1YmO5A0vRZYvdO9Y98REEAfU17Y21YjWwl2H41BuHGjJ/vSyVQ1ASE4Q7hBdCTJYNVr+PtMIHR6WFuNIBgA23sYvEQhBolnLpVfs3q5CjVwV3r6wx0ubaRkLlv0MTphic/lGQPFfaVdjYpBCKAr+G6k7t8elpMCf1oeVoopGM6y1WRSCmq2nZyf1n9oNXd4BcFvwnaQwQaEAPnTcZw1F4O6Z0Tc5BJOvJ5pQ79d3EJaOGyDJmezKBxV6mgeIH1ILkWc6nKf1JnqE4v8yCdRsvsTAPcIEn66jqTLpo5uvERroodHqNKP9aSbxvyHp8nkSLb35+w8NpRMlEg="
-      
+
 script:
   - mvn clean package --settings settings.xml
 

CHANGELOG.md

@@ -4,6 +4,17 @@ 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).
 
+## [1.2.22] -
+### Added
+- New annotation @PageableAsQueryParam for better Pageable support
+- Feature to serve from the same swagger-ui both, REST APIs that are deployed within the same application and external REST APIs  #309
+- Customizing operations, parameters and properties available through an SPI #293
+### Changed
+-  Autoconfigurations will not be loaded if classpath does not contain mvc/reactive dependencies or application is not web application #299
+### Fixed
+- Corrected the support of oauth2-redirect.html and oauth2RedirectUrl #311
+
+  
 ## [1.2.21] - 
 ### Added
 - Springdoc, Callable support #297

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.springdoc</groupId>
     <artifactId>springdoc-openapi</artifactId>
-    <version>1.2.22-SNAPSHOT</version>
+    <version>1.2.23-SNAPSHOT</version>
     <packaging>pom</packaging>
     <name>Spring openapi documentation generator</name>
     <description>Spring openapi documentation generator</description>

springdoc-openapi-common/pom.xml

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

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

@@ -9,6 +9,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.*;
+import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.AntPathMatcher;

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

@@ -126,6 +126,16 @@ Parameter buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter paramete
         if (parameterDoc.allowReserved()) {
             parameter.setAllowReserved(parameterDoc.allowReserved());
         }
+        setSchema(parameterDoc, components, jsonView, parameter);
+        setExamples(parameterDoc, parameter);
+        setExtensions(parameterDoc, parameter);
+        setParameterStyle(parameter, parameterDoc);
+        setParameterExplode(parameter, parameterDoc);
+
+        return parameter;
+    }
+
+    private void setSchema(io.swagger.v3.oas.annotations.Parameter parameterDoc, Components components, JsonView jsonView, Parameter parameter) {
         if (StringUtils.isNotBlank(parameterDoc.ref())) {
             parameter.$ref(parameterDoc.ref());
         } else {
@@ -144,13 +154,6 @@ Parameter buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter paramete
             }
             parameter.setSchema(schema);
         }
-
-        setExamples(parameterDoc, parameter);
-        setExtensions(parameterDoc, parameter);
-        setParameterStyle(parameter, parameterDoc);
-        setParameterExplode(parameter, parameterDoc);
-
-        return parameter;
     }
 
     Schema calculateSchema(Components components, java.lang.reflect.Parameter parameter, String paramName,

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

@@ -8,8 +8,8 @@
 import io.swagger.v3.oas.models.parameters.Parameter;
 import org.apache.commons.lang3.StringUtils;
 import org.springdoc.core.RequestInfo.ParameterType;
-import org.springdoc.core.customizer.OperationCustomizer;
-import org.springdoc.core.customizer.ParameterCustomizer;
+import org.springdoc.core.customizers.OperationCustomizer;
+import org.springdoc.core.customizers.ParameterCustomizer;
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.core.annotation.AnnotationUtils;
@@ -67,12 +67,12 @@ public abstract class AbstractRequestBuilder {
     private final AbstractParameterBuilder parameterBuilder;
     private final RequestBodyBuilder requestBodyBuilder;
     private final OperationBuilder operationBuilder;
-    private final List<OperationCustomizer> operationCustomizers;
-    private final List<ParameterCustomizer> parameterCustomizers;
+    private final Optional<List<OperationCustomizer>> operationCustomizers;
+    private final Optional<List<ParameterCustomizer>> parameterCustomizers;
 
     protected AbstractRequestBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
-                                     OperationBuilder operationBuilder, List<OperationCustomizer> operationCustomizers,
-                                     List<ParameterCustomizer> parameterCustomizers) {
+                                     OperationBuilder operationBuilder, Optional<List<OperationCustomizer>> operationCustomizers,
+                                     Optional<List<ParameterCustomizer>> parameterCustomizers) {
         super();
         this.parameterBuilder = parameterBuilder;
         this.requestBodyBuilder = requestBodyBuilder;
@@ -164,25 +164,15 @@ public Operation build(Components components, HandlerMethod handlerMethod, Reque
     }
 
     protected Operation customiseOperation(Operation operation, HandlerMethod handlerMethod) {
-        if (!CollectionUtils.isEmpty(operationCustomizers)) {
-            for (OperationCustomizer customizer : operationCustomizers) {
-                operation = customizer.customize(operation, handlerMethod);
-            }
-        }
+        operationCustomizers.ifPresent(customizers -> customizers.forEach(customizer -> customizer.customize(operation, handlerMethod)));
         return operation;
     }
 
     protected Parameter customiseParameter(Parameter parameter, ParameterInfo parameterInfo, HandlerMethod handlerMethod) {
-        if (!CollectionUtils.isEmpty(parameterCustomizers)) {
-            for (ParameterCustomizer customizer : parameterCustomizers) {
-                parameter = customizer.customize(parameter, parameterInfo.getParameter(), handlerMethod);
-            }
-        }
+        parameterCustomizers.ifPresent(customizers -> customizers.forEach(customizer -> customizer.customize(parameter, parameterInfo.getParameter(), handlerMethod)));
         return parameter;
     }
 
-    ;
-
     protected boolean isParamToIgnore(java.lang.reflect.Parameter parameter) {
         if (parameter.isAnnotationPresent(PathVariable.class)) {
             return false;

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

@@ -1,6 +1,6 @@
 package org.springdoc.core;
 
-import org.springdoc.api.OpenApiCustomiser;
+import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springframework.util.CollectionUtils;
 
 import java.util.ArrayList;
@@ -46,10 +46,10 @@ public List<OpenApiCustomiser> getOpenApiCustomisers() {
     }
 
     public static class Builder {
+        private final List<OpenApiCustomiser> openApiCustomisers = new ArrayList<>();
         private String group;
         private List<String> pathsToMatch;
         private List<String> packagesToScan;
-        private final List<OpenApiCustomiser> openApiCustomisers = new ArrayList<>();
 
         private Builder() {
             // use static factory method in parent class

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

@@ -4,9 +4,10 @@
 import io.swagger.v3.oas.models.OpenAPI;
 import org.springdoc.core.converters.ObjectNodeConverter;
 import org.springdoc.core.converters.PropertyCustomizingConverter;
-import org.springdoc.core.customizer.PropertyCustomizer;
+import org.springdoc.core.customizers.PropertyCustomizer;
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -32,7 +33,7 @@ ObjectNodeConverter objectNodeConverter() {
     }
 
     @Bean
-    PropertyCustomizingConverter propertyCustomizingConverter(List<PropertyCustomizer> customizers){
+    PropertyCustomizingConverter propertyCustomizingConverter(Optional<List<PropertyCustomizer>> customizers) {
         return new PropertyCustomizingConverter(customizers);
     }
 
@@ -43,10 +44,11 @@ IgnoredParameterAnnotationsDefault ignoredParameterAnnotationsDefault() {
 
     @Bean
     public OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationContext context, SecurityParser securityParser, List<ModelConverter> modelConverters) {
-        return new OpenAPIBuilder(openAPI, context, securityParser,modelConverters);
+        return new OpenAPIBuilder(openAPI, context, securityParser, modelConverters);
     }
 
     @Bean
+    @ConditionalOnWebApplication
     public OperationBuilder operationBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
                                              SecurityParser securityParser, OpenAPIBuilder openAPIBuilder, PropertyResolverUtils propertyResolverUtils) {
         return new OperationBuilder(parameterBuilder, requestBodyBuilder,
@@ -59,6 +61,7 @@ public PropertyResolverUtils propertyResolverUtils(ConfigurableBeanFactory facto
     }
 
     @Bean
+    @ConditionalOnWebApplication
     public RequestBodyBuilder requestBodyBuilder(AbstractParameterBuilder parameterBuilder) {
         return new RequestBodyBuilder(parameterBuilder);
     }

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

@@ -8,6 +8,7 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.util.CollectionUtils;
 
+import java.net.URL;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -116,6 +117,11 @@ public static void addGroup(String group) {
         swaggerUrls.add(swaggerUrl);
     }
 
+    public static void addGroup(String group, String url) {
+        SwaggerUrl swaggerUrl = new SwaggerUrl(group, url);
+        swaggerUrls.add(swaggerUrl);
+    }
+
     public static List<SwaggerUrl> getSwaggerUrls() {
         return swaggerUrls;
     }
@@ -125,14 +131,18 @@ public static void setSwaggerUrls(List<SwaggerUrl> swaggerUrls) {
     }
 
     public static void addUrl(String url) {
-        swaggerUrls.forEach(elt -> elt.setUrl(url + DEFAULT_PATH_SEPARATOR + elt.getName()));
+        swaggerUrls.forEach(elt ->
+        {
+            if (StringUtils.isEmpty(elt.url))
+                elt.setUrl(url + DEFAULT_PATH_SEPARATOR + elt.getName());
+        });
     }
 
     public Map<String, Object> getConfigParameters() {
         final Map<String, Object> params = new TreeMap<>();
         put("layout", layout, params);
         put(CONFIG_URL_PROPERTY, configUrl, params);
-        put( "validatorUrl", validatorUrl, params);
+        put("validatorUrl", validatorUrl, params);
         put("filter", filter, params);
         put("deepLinking", this.deepLinking, params);
         put("displayOperationId", displayOperationId, params);
@@ -339,10 +349,24 @@ public void setUrl(String url) {
         this.url = url;
     }
 
+    public boolean isValidUrl(String url) {
+        try {
+            new URL(url).toURI();
+            return true;
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
     static class SwaggerUrl {
         private String url;
         private String name;
 
+        public SwaggerUrl(String group, String url) {
+            this.url = url;
+            this.name = group;
+        }
+
         public SwaggerUrl(String group) {
             this.name = group;
         }