[Java Spring OAS3] Minor fixes and general improvements (#11229)

* * Use Relative Imports for org.springframework.core.io.Resource
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore

* Add spring-stubs-oas3.yaml test config

* Generate all samples

* Explain fromOperation override to support more logic-less templates.

* Support RootUriTemplateHandler from spring-boot

* Revert "Support RootUriTemplateHandler from spring-boot"

This reverts commit 1915f8b.

* Evaluate additional property useSpringfox as Boolean

* Generate all samples after merge (java-camel)

* Fix typo

* Move java-camel test deom samples.circleci.spring to samples.circleci profile.

* re-generate all samples after merge

* Generate samples and docs after merge

* Generate samples after merge conflicts resolved

Author: cachescrubber

bin/configs/spring-stubs-oas3.yaml

@@ -0,0 +1,11 @@
+generatorName: spring
+outputDir: samples/openapi3/client/petstore/spring-stubs
+inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  groupId: org.openapitools.openapi3
+  artifactId: spring-stubs
+  oas3: "true"
+  interfaceOnly: "true"
+  singleContentTypes: "true"
+  hideGenerationTimestamp: "true"

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

@@ -20,7 +20,6 @@
 import static org.apache.commons.lang3.StringUtils.isNotEmpty;
 import static org.openapitools.codegen.utils.StringUtils.camelize;
 
-import io.swagger.v3.oas.models.media.Schema;
 import java.io.File;
 import java.net.URL;
 import java.util.ArrayList;
@@ -33,6 +32,12 @@
 import java.util.regex.Matcher;
 import java.util.stream.Collectors;
 
+import com.samskivert.mustache.Mustache;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.PathItem;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.servers.Server;
 import org.apache.commons.lang3.tuple.Pair;
 import org.openapitools.codegen.CliOption;
 import org.openapitools.codegen.CodegenConstants;
@@ -59,12 +64,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.samskivert.mustache.Mustache;
-
-import io.swagger.v3.oas.models.OpenAPI;
-import io.swagger.v3.oas.models.Operation;
-import io.swagger.v3.oas.models.PathItem;
-
 public class SpringCodegen extends AbstractJavaCodegen
         implements BeanValidationFeatures, PerformBeanValidationFeatures, OptionalFeatures {
     private final Logger LOGGER = LoggerFactory.getLogger(SpringCodegen.class);
@@ -390,8 +389,11 @@ public void processOpts() {
         }
         additionalProperties.put(UNHANDLED_EXCEPTION_HANDLING, this.isUnhandledException());
 
-        typeMapping.put("file", "org.springframework.core.io.Resource");
-        importMapping.put("org.springframework.core.io.Resource", "org.springframework.core.io.Resource");
+        typeMapping.put("file", "Resource");
+        importMapping.put("Resource", "org.springframework.core.io.Resource");
+        importMapping.put("Pageable", "org.springframework.data.domain.Pageable");
+        importMapping.put("DateTimeFormat", "org.springframework.format.annotation.DateTimeFormat");
+        importMapping.put("ApiIgnore", "springfox.documentation.annotations.ApiIgnore");
 
         if (useOptional) {
             writePropertyBack(USE_OPTIONAL, useOptional);
@@ -899,6 +901,11 @@ public void setUnhandledException(boolean unhandledException) {
     public void postProcessModelProperty(CodegenModel model, CodegenProperty property) {
         super.postProcessModelProperty(model, property);
 
+        // add org.springframework.format.annotation.DateTimeFormat when needed
+        if (property.isDate || property.isDateTime) {
+            model.imports.add("DateTimeFormat");
+        }
+
         if ("null".equals(property.example)) {
             property.example = null;
         }
@@ -938,6 +945,29 @@ public CodegenModel fromModel(String name, Schema model) {
         return codegenModel;
     }
 
+    /*
+     * Add dynamic imports based on the parameters and vendor extensions of an operation.
+     * The imports are expanded by the mustache {{import}} tag available to model and api
+     * templates.
+     */
+    @Override
+    public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List<Server> servers) {
+        CodegenOperation codegenOperation = super.fromOperation(path, httpMethod, operation, servers);
+
+        // add org.springframework.format.annotation.DateTimeFormat when needed
+        codegenOperation.allParams.stream().filter(p -> p.isDate || p.isDateTime).findFirst()
+            .ifPresent(p -> codegenOperation.imports.add("DateTimeFormat"));
+
+        // add org.springframework.data.domain.Pageable import when needed
+        if (codegenOperation.vendorExtensions.containsKey("x-spring-paginated")) {
+            codegenOperation.imports.add("Pageable");
+            if (Boolean.TRUE.equals(additionalProperties.get("useSpringfox"))) {
+                codegenOperation.imports.add("ApiIgnore");
+            }
+        }
+        return codegenOperation;
+    }
+
     @Override
     public Map<String, Object> postProcessModelsEnum(Map<String, Object> objs) {
         objs = super.postProcessModelsEnum(objs);

modules/openapi-generator/src/main/resources/JavaSpring/additionalEnumTypeAnnotations.mustache

@@ -1,2 +1,3 @@
-{{#additionalEnumTypeAnnotations}}{{{.}}}
+{{#additionalEnumTypeAnnotations}}
+{{{.}}}
 {{/additionalEnumTypeAnnotations}}

modules/openapi-generator/src/main/resources/JavaSpring/additionalModelTypeAnnotations.mustache

@@ -1,2 +1,3 @@
-{{#additionalModelTypeAnnotations}}{{{.}}}
+{{#additionalModelTypeAnnotations}}
+{{{.}}}
 {{/additionalModelTypeAnnotations}}

modules/openapi-generator/src/main/resources/JavaSpring/api.mustache

@@ -37,9 +37,9 @@ import org.springframework.stereotype.Controller;
 {{/useSpringController}}
 import org.springframework.web.bind.annotation.*;
 {{#jdk8-no-delegate}}
-    {{^reactive}}
+{{^reactive}}
 import org.springframework.web.context.request.NativeWebRequest;
-    {{/reactive}}
+{{/reactive}}
 {{/jdk8-no-delegate}}
 import org.springframework.web.multipart.MultipartFile;
 {{#reactive}}
@@ -59,21 +59,28 @@ import java.util.Map;
 import java.util.Optional;
 {{/jdk8-no-delegate}}
 {{^jdk8-no-delegate}}
-    {{#useOptional}}
+{{#useOptional}}
 import java.util.Optional;
-    {{/useOptional}}
+{{/useOptional}}
 {{/jdk8-no-delegate}}
 {{#async}}
 import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
 {{/async}}
+import javax.annotation.Generated;
+
 {{>generatedAnnotation}}
 {{#useBeanValidation}}
 @Validated
 {{/useBeanValidation}}
 {{#useSpringController}}
 @Controller
 {{/useSpringController}}
-{{#oas3}}@Tag(name = "{{{baseName}}}", description = "the {{{baseName}}} API"){{/oas3}}{{^oas3}}@Api(value = "{{{baseName}}}", description = "the {{{baseName}}} API"){{/oas3}}
+{{#oas3}}
+@Tag(name = "{{{baseName}}}", description = "the {{{baseName}}} API")
+{{/oas3}}
+{{^oas3}}
+@Api(value = "{{{baseName}}}", description = "the {{{baseName}}} API")
+{{/oas3}}
 {{#operations}}
 {{#virtualService}}
 @VirtualService
@@ -121,8 +128,13 @@ public interface {{classname}} {
     {{/virtualService}}
     {{#oas3}}
     @Operation(
-        summary = "{{{summary}}}",
+        operationId = "{{{operationId}}}",
+        {{#summary}}
+        summary = "{{{.}}}",
+        {{/summary}}
+        {{#vendorExtensions.x-tags}}
         tags = { {{#vendorExtensions.x-tags}}"{{tag}}"{{^-last}}, {{/-last}}{{/vendorExtensions.x-tags}} },
+        {{/vendorExtensions.x-tags}}
         responses = {
             {{#responses}}
             @ApiResponse(responseCode = "{{{code}}}", description = "{{{message}}}"{{#baseType}}, content = @Content(mediaType = "application/json", schema = @Schema(implementation =  {{{baseType}}}.class)){{/baseType}}){{^-last}},{{/-last}}
@@ -189,15 +201,15 @@ public interface {{classname}} {
     {{#jdk8-default-interface}}default {{/jdk8-default-interface}}{{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{#delegate-method}}_{{/delegate-method}}{{operationId}}(
         {{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},
         {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
-        {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
-        {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
+        {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
+        {{/hasParams}}{{#useSpringfox}}@ApiIgnore {{/useSpringfox}}final Pageable pageable{{/vendorExtensions.x-spring-paginated}}
     ){{^jdk8-default-interface}};{{/jdk8-default-interface}}{{#jdk8-default-interface}}{{#unhandledException}} throws Exception{{/unhandledException}} {
         {{#delegate-method}}
         return {{operationId}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, pageable{{/vendorExtensions.x-spring-paginated}});
     }
 
     // Override this method
-    {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
+    {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
         {{/delegate-method}}
         {{^isDelegate}}
         {{>methodBody}}

modules/openapi-generator/src/main/resources/JavaSpring/apiController.mustache

@@ -31,35 +31,35 @@ import org.springframework.web.bind.annotation.CookieValue;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RequestPart;
 {{/jdk8}}
+import org.springframework.beans.factory.annotation.Autowired;
 {{^isDelegate}}
 import org.springframework.web.context.request.NativeWebRequest;
 {{/isDelegate}}
 {{^jdk8}}
 import org.springframework.web.multipart.MultipartFile;
-{{#vendorExtensions.x-spring-paginated}}
-import org.springframework.data.domain.Pageable;
-{{/vendorExtensions.x-spring-paginated}}
 
-    {{#useBeanValidation}}
+{{#useBeanValidation}}
 import javax.validation.constraints.*;
 import javax.validation.Valid;
-    {{/useBeanValidation}}
+{{/useBeanValidation}}
 {{/jdk8}}
 {{#jdk8}}
 import java.util.Optional;
 {{/jdk8}}
 {{^jdk8}}
-    {{#useOptional}}
+{{#useOptional}}
 import java.util.Optional;
-    {{/useOptional}}
+{{/useOptional}}
 {{/jdk8}}
 {{^jdk8}}
 import java.util.List;
 import java.util.Map;
-    {{#async}}
+{{#async}}
 import java.util.concurrent.Callable;
-    {{/async}}
+{{/async}}
 {{/jdk8}}
+import javax.annotation.Generated;
+
 {{>generatedAnnotation}}
 @Controller
 {{=<% %>=}}
@@ -71,7 +71,7 @@ public class {{classname}}Controller implements {{classname}} {
 
     private final {{classname}}Delegate delegate;
 
-    public {{classname}}Controller(@org.springframework.beans.factory.annotation.Autowired(required = false) {{classname}}Delegate delegate) {
+    public {{classname}}Controller(@Autowired(required = false) {{classname}}Delegate delegate) {
     {{#jdk8}}
         this.delegate = Optional.ofNullable(delegate).orElse(new {{classname}}Delegate() {});
     }
@@ -93,7 +93,7 @@ public class {{classname}}Controller implements {{classname}} {
     {{/jdk8}}
     private final NativeWebRequest request;
 
-    @org.springframework.beans.factory.annotation.Autowired
+    @Autowired
     public {{classname}}Controller(NativeWebRequest request) {
         this.request = request;
     }
@@ -132,7 +132,7 @@ public class {{classname}}Controller implements {{classname}} {
     public {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}(
         {{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},
         {{/-last}}{{/allParams}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
-        {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final Pageable pageable{{/vendorExtensions.x-spring-paginated}}
+        {{/hasParams}}{{#useSpringfox}}@ApiIgnore {{/useSpringfox}}final Pageable pageable{{/vendorExtensions.x-spring-paginated}}
     ) {
     {{^isDelegate}}
         {{^async}}

modules/openapi-generator/src/main/resources/JavaSpring/apiDelegate.mustache

@@ -2,9 +2,6 @@ package {{package}};
 
 {{#imports}}import {{import}};
 {{/imports}}
-{{#vendorExtensions.x-spring-paginated}}
-import org.springframework.data.domain.Pageable;
-{{/vendorExtensions.x-spring-paginated}}
 {{#jdk8}}
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -34,6 +31,7 @@ import java.util.Optional;
 {{#async}}
 import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
 {{/async}}
+import javax.annotation.Generated;
 
 {{#operations}}
 /**
@@ -72,7 +70,7 @@ public interface {{classname}}Delegate {
      */
     {{#jdk8-default-interface}}default {{/jdk8-default-interface}}{{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#isArray}}List<{{/isArray}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{#isArray}}>{{/isArray}}{{/isFile}} {{paramName}}{{^-last}},
         {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
-        {{/hasParams}}ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}}{{^jdk8-default-interface}};{{/jdk8-default-interface}}{{#jdk8-default-interface}} {
+        {{/hasParams}}ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}}{{^jdk8-default-interface}};{{/jdk8-default-interface}}{{#jdk8-default-interface}} {
         {{>methodBody}}
     }{{/jdk8-default-interface}}
 

modules/openapi-generator/src/main/resources/JavaSpring/apiException.mustache

@@ -1,5 +1,7 @@
 package {{apiPackage}};
 
+import javax.annotation.Generated;
+
 /**
  * The exception that can be used to store the HTTP status code returned by an API response.
  */

modules/openapi-generator/src/main/resources/JavaSpring/apiOriginFilter.mustache

@@ -2,6 +2,7 @@ package {{apiPackage}};
 
 import java.io.IOException;
 
+import javax.annotation.Generated;
 import javax.servlet.*;
 import javax.servlet.http.HttpServletResponse;
 

modules/openapi-generator/src/main/resources/JavaSpring/apiResponseMessage.mustache

@@ -1,5 +1,6 @@
 package {{apiPackage}};
 
+import javax.annotation.Generated;
 import javax.xml.bind.annotation.XmlTransient;
 
 {{>generatedAnnotation}}