add support for useBeanValidation in spring http interface

Author: Picazsoo

.github/workflows/samples-jdk17.yaml

@@ -7,6 +7,8 @@ on:
       - samples/client/petstore/java-helidon-client/v3/mp/**
       - samples/client/petstore/java-helidon-client/v3/se/**
       - samples/client/petstore/spring-http-interface-reactive/**
+      - samples/client/petstore/spring-http-interface-reactive-bean-validation/**
+      - samples/client/petstore/spring-http-interface-bean-validation/**
       - samples/client/petstore/spring-http-interface/**
       - samples/client/petstore/spring-http-interface-reactive-noResponseEntity/**
       - samples/client/petstore/spring-http-interface-noResponseEntity/**
@@ -24,6 +26,8 @@ on:
       - samples/client/petstore/java-helidon-client/v3/mp/**
       - samples/client/petstore/java-helidon-client/v3/se/**
       - samples/client/petstore/spring-http-interface-reactive/**
+      - samples/client/petstore/spring-http-interface-reactive-bean-validation/**
+      - samples/client/petstore/spring-http-interface-bean-validation/**
       - samples/client/petstore/spring-http-interface/**
       - samples/client/petstore/spring-http-interface-reactive-noResponseEntity/**
       - samples/client/petstore/spring-http-interface-noResponseEntity/**
@@ -47,6 +51,8 @@ jobs:
           - samples/client/petstore/java-helidon-client/v3/mp/
           - samples/client/petstore/java-helidon-client/v3/se
           - samples/client/petstore/spring-http-interface-reactive
+          - samples/client/petstore/spring-http-interface-reactive-bean-validation
+          - samples/client/petstore/spring-http-interface-bean-validation
           - samples/client/petstore/spring-http-interface
           - samples/client/petstore/spring-http-interface-reactive-noResponseEntity
           - samples/client/petstore/spring-http-interface-noResponseEntity

bin/configs/spring-http-interface-bean-validation.yaml

@@ -0,0 +1,17 @@
+generatorName: spring
+library: spring-http-interface
+outputDir: samples/client/petstore/spring-http-interface-validation
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  artifactId: spring-http-interface
+  snapshotVersion: "true"
+  hideGenerationTimestamp: "true"
+  modelNameSuffix: 'Dto'
+  generatedConstructorWithRequiredArgs: "false"
+  # validation should be respected
+  useBeanValidation: "true"
+  # documentation provider should be ignored
+  documentationProvider: "springdoc"
+  # annotation provider should be ignored
+  annotationLibrary: "swagger2"

bin/configs/spring-http-interface-noResponseEntity.yaml

@@ -13,7 +13,6 @@ additionalProperties:
   documentationProvider: "springdoc"
   # annotation provider should be ignored
   annotationLibrary: "swagger2"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
+  #  useBeanValidation should default to "false" when not specified
+  #  performBeanValidation should default to "false" when not specified
   useResponseEntity: "false"

bin/configs/spring-http-interface-reactive-bean-validation.yaml

@@ -0,0 +1,17 @@
+generatorName: spring
+library: spring-http-interface
+outputDir: samples/client/petstore/spring-http-interface-reactive-bean-validation
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  artifactId: spring-http-interface-reactive
+  snapshotVersion: "true"
+  hideGenerationTimestamp: "true"
+  reactive: "true"
+  # validation should be respected
+  useBeanValidation: "true"
+  # documentation provider should be ignored
+  documentationProvider: "springfox"
+  # annotation provider should be ignored
+  annotationLibrary: "swagger1"
+

bin/configs/spring-http-interface-reactive-noResponseEntity.yaml

@@ -12,8 +12,7 @@ additionalProperties:
   documentationProvider: "springfox"
   # annotation provider should be ignored
   annotationLibrary: "swagger1"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
+  #  useBeanValidation should default to "false" when not specified
+  #  performBeanValidation should default to "false" when not specified
   useResponseEntity: "false"
 

bin/configs/spring-http-interface-reactive.yaml

@@ -12,7 +12,5 @@ additionalProperties:
   documentationProvider: "springfox"
   # annotation provider should be ignored
   annotationLibrary: "swagger1"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
-
+#  useBeanValidation should default to "false" when not specified
+#  performBeanValidation should default to "false" when not specified

bin/configs/spring-http-interface.yaml

@@ -13,6 +13,5 @@ additionalProperties:
   documentationProvider: "springdoc"
   # annotation provider should be ignored
   annotationLibrary: "swagger2"
-  # validation should be ignored
-  useBeanValidation: "true"
-  performBeanValidation: "true"
+#  useBeanValidation should default to "false" when not specified
+#  performBeanValidation should default to "false" when not specified

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

@@ -384,8 +384,18 @@ public void processOpts() {
             documentationProvider = DocumentationProvider.NONE;
             annotationLibrary = AnnotationLibrary.NONE;
             useJakartaEe = true;
-            useBeanValidation = false;
-            performBeanValidation = false;
+            if(additionalProperties.containsKey(USE_BEANVALIDATION)) {
+                useBeanValidation = Boolean.parseBoolean(additionalProperties.get(USE_BEANVALIDATION).toString());
+            } else {
+                //default to false if not specified
+                useBeanValidation = false;
+            }
+            if(additionalProperties.containsKey(PERFORM_BEANVALIDATION)) {
+                performBeanValidation = Boolean.parseBoolean(additionalProperties.get(PERFORM_BEANVALIDATION).toString());
+            } else {
+                //default to false if not specified
+                performBeanValidation = false;
+            }
 
             additionalProperties.put(USE_JAKARTA_EE, useJakartaEe);
             additionalProperties.put(USE_BEANVALIDATION, useBeanValidation);

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-http-interface/api.mustache

@@ -17,6 +17,11 @@ import org.springframework.web.bind.annotation.*;
 import org.springframework.web.service.annotation.*;
 import org.springframework.web.multipart.MultipartFile;
 {{#reactive}}
+{{#useBeanValidation}}
+import {{javaxPackage}}.validation.Valid;
+import {{javaxPackage}}.validation.constraints.*;
+{{^useSpringBuiltInValidation}}import org.springframework.validation.annotation.Validated;{{/useSpringBuiltInValidation}}
+{{/useBeanValidation}}
 
 import org.springframework.http.codec.multipart.Part;
 import reactor.core.publisher.Flux;
@@ -30,7 +35,7 @@ import {{javaxPackage}}.annotation.Generated;
 
 
 {{>generatedAnnotation}}
-
+{{#useBeanValidation}}{{^useSpringBuiltInValidation}}@Validated{{/useSpringBuiltInValidation}}{{/useBeanValidation}}
 {{#operations}}
 public interface {{classname}} {
 {{#operation}}