Merge pull request #3 from springdoc/master

Update

Author: joaodias14

.travis.yml

@@ -8,10 +8,16 @@ cache:
 
 addons:
   sonarcloud:
-    organization: "springdoc"
+    organization: "springdoc-openapi"
+    token:
+      secure: "S5zeA+Vvbe7LG450OAtd5TrBRL8fhaWgJjzAp3RzS797++2xrN92jI74h5NL0MiYBd6NKoWql1WJaMKHCfo/EJ6RdExdw71126B2k061iK54y8pxom+ADFigKgkVzHgnV28uBioC2DIcVvRDk8WkX6IZ9I6C72TzWapXrlCnRkSY1lsfOwvqahTYheaDzRKWN5WoBm8M63IiciMz21SSrdm20fjQeY90EI0EfKn0jjJWL8WKmDa98MeSsJWBwR964ICKRvRq9CGTjTZVhL+D0VYt4tS7kpoN9QatL6SL/octL6jXhgGqnFu8AWRwe1RX7hM9jjDLCkXrz6pr9+t4ts8lo7CcG1YmO5A0vRZYvdO9Y98REEAfU17Y21YjWwl2H41BuHGjJ/vSyVQ1ASE4Q7hBdCTJYNVr+PtMIHR6WFuNIBgA23sYvEQhBolnLpVfs3q5CjVwV3r6wx0ubaRkLlv0MTphic/lGQPFfaVdjYpBCKAr+G6k7t8elpMCf1oeVoopGM6y1WRSCmq2nZyf1n9oNXd4BcFvwnaQwQaEAPnTcZw1F4O6Z0Tc5BJOvJ5pQ79d3EJaOGyDJmezKBxV6mgeIH1ILkWc6nKf1JnqE4v8yCdRsvsTAPcIEn66jqTLpo5uvERroodHqNKP9aSbxvyHp8nkSLb35+w8NpRMlEg="
 
 script:
-  - mvn clean deploy --settings settings.xml
-  - mvn sonar:sonar -Dsonar.login=$SONAR_TOKEN -DskipTests
+  - mvn clean package --settings settings.xml
 
+deploy:
+  provider: script
+  script: mvn deploy -DskipTests sonar:sonar -Dsonar.projectKey=springdoc_springdoc-openapi --settings settings.xml
+  on:
+    branch: master
 

CHANGELOG.md

@@ -4,15 +4,94 @@ 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]
+## [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
+### Added
+- Added support for multiple OpenAPI definitions in spring webflux #329
+
+## [1.2.24] -
+### Changed
+- Improve beans loading, if projects uses the UI only #321
+
+## [1.2.23] -
+### Added
+- Added migration guide from springfox #292
+- Added support for @JsonViews with spring @requestbody annotation #315
+- Provide oauth2RedirectUrl, if not declared #320
+### Fixed
+- Wrong server url with when grouped api name contains special charater #312
+
+## [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
+### Removed
+- Property `springdoc.api-docs.groups.enabled` removed, as not needed any more for enabling multiple OpenAPI definitions support #296
+### Changed 
+- Improve springdoc-openapi beans loading #290 #294
 
-### Addded
+## [1.2.20] - 2019-12-23
+### Changed 
+- Preserve order of @Parameters for spring-boot 2.2 #289
+### Removed
+- Remove @EnableWebMvc from SwaggerConfig (not needed for Spring Boot) #236 #150
+
+## [1.2.19] - 2019-12-22
+### Added
+- Support for Multiple OpenAPI definitions in one Spring Boot #213
+- Support for spring-context-indexer #262
+- Added support using properties from application.yml for description field in swagger-annotations #231
+- Make validatorUrl configurable and fix overwrites #281
+- Improve support of HttpEntity. fixes #280
+### Changed 
+- Ignore ServerHttpRequest and ServerHttpResponse Webflux #270
+- Preserve order of parameters in @Parameters annotation #274
+- Changed the default value if consumes is missing, to MediaType.APPLICATION_JSON_VALUE #275
+- Renamed actuator property to springdoc.show-actuator #286
+### Fixed
+- Static content no longer delivered #246
+
+## [1.2.18] - 2019-12-14
+### Added
 - Globally exclude params for webflux #228
+- Added ability to ignore param with @hidden annotation at class level #255
+- Support of spring.mvc.servlet.path #238
+- ignore Authentication in controller params #245
+- Support for oauth2RedirectUrl  #240
+- Support of @Hidden at class level. #260
+- Ability for using properties from application.yml to declare security urls: (openIdConnectUrl - authorizationUrl - refreshUrl - tokenUrl) #231
+- Added support of annotation @Parameters (without @Operation) #241
+### Changed 
+- Downgrade swagger-ui to 3.24.0, fixes #239
+### Fixed
+- Fixes error with JDK 11 + Kotlin #248
 
 ## [1.2.17] - 2019-12-05
-### Addded
+### Added
 - Handle multiple endpoints on @GetParam #219
-
 ### Changed
 - Upgrade Springboot to 2.2.1
 - Upgrade Swagger UI to 3.24.3
@@ -23,10 +102,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add Spring Boot metadata for config properties. #208
 - Explicitly set which packages/ paths to scan #210
 - Disable the try it out button #214
-
 ### Changed
 - Changed getOpenApi in AbstractOpenApiResource to synchronized #209
-
 ### Fixed
 - Missing Response Content - #212
 
@@ -372,7 +449,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [1.0.1] - 2019-07-24
 ### Added
-- Added sample codes
+- Added demo applications, sample code
 
 ## [1.0.0] - 2019-07-23
 ### Added

README.md

@@ -1,8 +1,11 @@
 [![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=org.springdoc%3Aspringdoc-openapi&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.springdoc%3Aspringdoc-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)
 
+# [Full documentation](https://springdoc.org)
+
 # **Introduction**
 
 The springdoc-openapi Java library helps automating the generation of API documentation using Spring Boot projects.

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.springdoc</groupId>
     <artifactId>springdoc-openapi</artifactId>
-    <version>1.2.18-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.18-SNAPSHOT</version>
+        <version>1.2.27-SNAPSHOT</version>
     </parent>
     <dependencies>
         <dependency>

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

@@ -9,23 +9,27 @@
 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;
 import org.springframework.util.CollectionUtils;
+import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
 
+import java.io.UnsupportedEncodingException;
 import java.lang.reflect.Method;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.time.Instant;
 import java.util.*;
 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 {
 
@@ -41,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,
@@ -53,9 +59,23 @@ protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequest
         this.openApiCustomisers = openApiCustomisers;
     }
 
+    protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+                                      AbstractResponseBuilder responseBuilder, OperationBuilder operationParser,
+                                      Optional<List<OpenApiCustomiser>> openApiCustomisers, List<String> pathsToMatch, List<String> packagesToScan,boolean cacheDisabled) {
+        super();
+        this.openAPIBuilder = openAPIBuilder;
+        this.requestBuilder = requestBuilder;
+        this.responseBuilder = responseBuilder;
+        this.operationParser = operationParser;
+        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();
@@ -186,8 +206,8 @@ private void calculateJsonView(io.swagger.v3.oas.annotations.Operation apiOperat
              */
             jsonViewAnnotationForRequestBody = (JsonView) Arrays.stream(ReflectionUtils.getParameterAnnotations(method))
                     .filter(arr -> Arrays.stream(arr)
-                            .anyMatch(annotation -> annotation.annotationType()
-                                    .equals(io.swagger.v3.oas.annotations.parameters.RequestBody.class)))
+                            .anyMatch(annotation -> (annotation.annotationType()
+                                    .equals(io.swagger.v3.oas.annotations.parameters.RequestBody.class) || annotation.annotationType().equals(RequestBody.class))))
                     .flatMap(Arrays::stream).filter(annotation -> annotation.annotationType().equals(JsonView.class))
                     .reduce((a, b) -> null).orElse(jsonViewAnnotation);
         }
@@ -276,4 +296,12 @@ protected boolean isPackageToScan(String aPackage) {
     protected boolean isPathToMatch(String operationPath) {
         return CollectionUtils.isEmpty(pathsToMatch) || pathsToMatch.stream().anyMatch(pattern -> antPathMatcher.match(pattern, operationPath));
     }
+
+    protected String decode(String requestURI) {
+        try {
+            return URLDecoder.decode(requestURI, StandardCharsets.UTF_8.toString());
+        } catch (UnsupportedEncodingException e) {
+            return requestURI;
+        }
+    }
 }

springdoc-openapi-common/src/main/java/org/springdoc/config/SpringDocConfiguration.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,