Implement Source DocumentationProvider, spring-mvc decommission (#11531)

* - Upgrade swagger-ui to 4.4.1
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.

* Generate Samples

* Restore generator-online classes
Fix spring-mvc builds

* Generate Samples

* Do not generate SpringFoxConfiguration.java when reactive ist set.

* Fix generation of SpringFoxConfiguration

* Generate Documentation

* Reactive support: add dependency management for springdoc-openapi-webflux-ui

* Generate Samples

* Change SpringBootApplication to OpenApiGeneratorApplication

* Generate Samples

* Implement SwaggerUIFeatures in SpringCodegen

* Generate Samples

* Add useSwaggerUI: true to some test configs

* Generate Samples

* Update Documentation

* Update Documentation

* Update README.mustache

* Generate Samples

* useSwaggerUI is true by default

* Generate Samples

* Update Documentation

* Add deprecation warnings to cli opts; Log a deprecation warning

* Update Documentation

* Generate Samples

* Remove spring-mvc library

* Remove spring-mvc from project and CI configs

* Check whether the selected documentation provider requires us to boostrap swagger-ui.

* Generate Samples

* Generate samples

* Generate samples

* Generate samples

samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES

@@ -1,6 +1,6 @@
 README.md
 pom.xml
-src/main/java/org/openapitools/OpenAPI2SpringBoot.java
+src/main/java/org/openapitools/OpenApiGeneratorApplication.java
 src/main/java/org/openapitools/RFC3339DateFormat.java
 src/main/java/org/openapitools/api/AnotherFakeApi.java
 src/main/java/org/openapitools/api/AnotherFakeApiController.java
@@ -16,6 +16,7 @@ src/main/java/org/openapitools/api/StoreApiController.java
 src/main/java/org/openapitools/api/UserApi.java
 src/main/java/org/openapitools/api/UserApiController.java
 src/main/java/org/openapitools/configuration/HomeController.java
+src/main/java/org/openapitools/configuration/SpringFoxConfiguration.java
 src/main/java/org/openapitools/model/AdditionalPropertiesAnyType.java
 src/main/java/org/openapitools/model/AdditionalPropertiesArray.java
 src/main/java/org/openapitools/model/AdditionalPropertiesBoolean.java
@@ -66,3 +67,5 @@ src/main/java/org/openapitools/model/User.java
 src/main/java/org/openapitools/model/XmlItem.java
 src/main/resources/application.properties
 src/main/resources/openapi.yaml
+src/main/resources/static/swagger-ui.html
+src/test/java/org/openapitools/OpenApiGeneratorApplicationTests.java

samples/server/petstore/springboot-beanvalidation-no-nullable/README.md

@@ -2,17 +2,26 @@
 
 Spring Boot Server
 
-
 ## Overview
 This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
 By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a server stub.
 This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.
 
-The underlying library integrating OpenAPI to SpringBoot is [springfox](https://github.com/springfox/springfox)
+The underlying library integrating OpenAPI to Spring Boot is [springfox](https://github.com/springfox/springfox).
+Springfox will generate an OpenAPI v2 (fka Swagger RESTful API Documentation Specification) specification based on the
+generated Controller and Model classes. The specification is available to download using the following url:
+http://localhost:80/v2/api-docs/
+
+**HEADS-UP**: Springfox is deprecated for removal in version 6.0.0 of openapi-generator. The project seems to be no longer
+maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is
+supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is,
+as an added bonus, OpenAPI v3 compatible.
+
+
 
 Start your server as a simple java application
 
 You can view the api documentation in swagger-ui by pointing to
-http://localhost:80/
+http://localhost:80/swagger-ui.html
 
 Change default port value in application.properties

samples/server/petstore/springboot-beanvalidation-no-nullable/pom.xml

@@ -10,6 +10,7 @@
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>
         <springfox.version>2.9.2</springfox.version>
+        <swagger-ui.version>4.4.1-1</swagger-ui.version>
     </properties>
     <parent>
         <groupId>org.springframework.boot</groupId>
@@ -40,6 +41,15 @@
             <artifactId>springfox-swagger2</artifactId>
             <version>${springfox.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.webjars</groupId>
+            <artifactId>swagger-ui</artifactId>
+            <version>${swagger-ui.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.webjars</groupId>
+            <artifactId>webjars-locator-core</artifactId>
+        </dependency>
         <!-- @Nullable annotation -->
         <dependency>
             <groupId>com.google.code.findbugs</groupId>
@@ -63,5 +73,10 @@
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java

@@ -1,52 +0,0 @@
-package org.openapitools;
-
-import com.fasterxml.jackson.databind.Module;
-import org.springframework.boot.CommandLineRunner;
-import org.springframework.boot.ExitCodeGenerator;
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.ComponentScan;
-import org.springframework.web.servlet.config.annotation.CorsRegistry;
-import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
-
-@SpringBootApplication
-@ComponentScan(basePackages = {"org.openapitools", "org.openapitools.api" , "org.openapitools.configuration"})
-public class OpenAPI2SpringBoot implements CommandLineRunner {
-
-    @Override
-    public void run(String... arg0) throws Exception {
-        if (arg0.length > 0 && arg0[0].equals("exitcode")) {
-            throw new ExitException();
-        }
-    }
-
-    public static void main(String[] args) throws Exception {
-        new SpringApplication(OpenAPI2SpringBoot.class).run(args);
-    }
-
-    static class ExitException extends RuntimeException implements ExitCodeGenerator {
-        private static final long serialVersionUID = 1L;
-
-        @Override
-        public int getExitCode() {
-            return 10;
-        }
-
-    }
-
-    @Bean
-    public WebMvcConfigurer webConfigurer() {
-        return new WebMvcConfigurer() {
-            /*@Override
-            public void addCorsMappings(CorsRegistry registry) {
-                registry.addMapping("/**")
-                        .allowedOrigins("*")
-                        .allowedMethods("*")
-                        .allowedHeaders("Content-Type");
-            }*/
-        };
-    }
-
-
-}

samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenApiGeneratorApplication.java

@@ -0,0 +1,17 @@
+package org.openapitools;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+
+@SpringBootApplication
+@ComponentScan(basePackages = {"org.openapitools", "org.openapitools.api" , "org.openapitools.configuration"})
+public class OpenApiGeneratorApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(OpenApiGeneratorApplication.class, args);
+    }
+
+
+}

samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/configuration/HomeController.java

@@ -1,8 +1,10 @@
 package org.openapitools.configuration;
 
+import org.springframework.context.annotation.Bean;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
-
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.GetMapping;
 
 /**
  * Home redirection to OpenAPI api documentation
@@ -10,10 +12,17 @@ import org.springframework.web.bind.annotation.RequestMapping;
 @Controller
 public class HomeController {
 
+    static final String API_DOCS_PATH = "/v2/api-docs";
+
+    @GetMapping(value = "/swagger-config.yaml", produces = "text/plain")
+    @ResponseBody
+    public String swaggerConfig() {
+        return "url: " + API_DOCS_PATH + "\n";
+    }
+
     @RequestMapping("/")
     public String index() {
         return "redirect:swagger-ui.html";
     }
 
-
-}
+}

samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/configuration/SpringFoxConfiguration.java

@@ -15,12 +15,13 @@ import springfox.documentation.spring.web.paths.RelativePathProvider;
 import springfox.documentation.spring.web.plugins.Docket;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
+import javax.annotation.Generated;
 import javax.servlet.ServletContext;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
+@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
 @Configuration
 @EnableSwagger2
-public class OpenAPIDocumentationConfig {
+public class SpringFoxConfiguration {
 
     ApiInfo apiInfo() {
         return new ApiInfoBuilder()
@@ -40,8 +41,9 @@ public class OpenAPIDocumentationConfig {
                 .select()
                     .apis(RequestHandlerSelectors.basePackage("org.openapitools.api"))
                     .build()
-                .directModelSubstitute(org.threeten.bp.LocalDate.class, java.sql.Date.class)
-                .directModelSubstitute(org.threeten.bp.OffsetDateTime.class, java.util.Date.class)
+                .pathProvider(new BasePathAwareRelativePathProvider(servletContext, basePath))
+                .directModelSubstitute(java.time.LocalDate.class, java.sql.Date.class)
+                .directModelSubstitute(java.time.OffsetDateTime.class, java.util.Date.class)
                 .apiInfo(apiInfo());
     }
 

samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/resources/application.properties

@@ -1,4 +1,3 @@
-springfox.documentation.swagger.v2.path=/api-docs
 server.port=80
 spring.jackson.date-format=org.openapitools.RFC3339DateFormat
 spring.jackson.serialization.WRITE_DATES_AS_TIMESTAMPS=false

samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/resources/static/swagger-ui.html

@@ -0,0 +1,60 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link rel="stylesheet" type="text/css" href="webjars/swagger-ui/swagger-ui.css" />
+  <link rel="icon" type="image/png" href="webjars/swagger-ui/favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="webjars/swagger-ui/favicon-16x16.png" sizes="16x16" />
+  <style>
+    html
+    {
+      box-sizing: border-box;
+      overflow: -moz-scrollbars-vertical;
+      overflow-y: scroll;
+    }
+
+    *,
+    *:before,
+    *:after
+    {
+      box-sizing: inherit;
+    }
+
+    body
+    {
+      margin:0;
+      background: #fafafa;
+    }
+  </style>
+</head>
+
+<body>
+<div id="swagger-ui"></div>
+
+<script src="webjars/swagger-ui/swagger-ui-bundle.js" charset="UTF-8"> </script>
+<script src="webjars/swagger-ui/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+<script>
+  window.onload = function() {
+    // Begin Swagger UI call region
+    const ui = SwaggerUIBundle({
+      configUrl: 'swagger-config.yaml',
+      dom_id: '#swagger-ui',
+      deepLinking: true,
+      presets: [
+        SwaggerUIBundle.presets.apis,
+        SwaggerUIStandalonePreset
+      ],
+      plugins: [
+        SwaggerUIBundle.plugins.DownloadUrl
+      ],
+      layout: "StandaloneLayout"
+    });
+    // End Swagger UI call region
+
+    window.ui = ui;
+  };
+</script>
+</body>
+</html>

samples/server/petstore/springboot-beanvalidation-no-nullable/src/test/java/org/openapitools/OpenApiGeneratorApplicationTests.java

@@ -0,0 +1,13 @@
+package org.openapitools;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class OpenApiGeneratorApplicationTests {
+
+    @Test
+    void contextLoads() {
+    }
+
+}