Merge pull request #952 from swagger-api/codegen-issue-4113

HugoMario · web-flow · commit 06863bf639ea · 2021-09-05T20:25:01.000-05:00
added formatter to fix issue with date parameters
diff --git a/src/main/java/io/swagger/codegen/v3/generators/java/SpringCodegen.java b/src/main/java/io/swagger/codegen/v3/generators/java/SpringCodegen.java
@@ -57,6 +57,8 @@ public class SpringCodegen extends AbstractJavaCodegen implements BeanValidation
     public static final String DEFAULT_INTERFACES = "defaultInterfaces";
     public static final String SPRING_BOOT_VERSION = "springBootVersion";
     public static final String SPRING_BOOT_VERSION_2 = "springBootV2";
+    public static final String DATE_PATTERN = "datePattern";
+    public static final String DATE_TIME_PATTERN = "dateTimePattern";
 
     public static final String THROWS_EXCEPTION = "throwsException";
 
@@ -113,6 +115,8 @@ public SpringCodegen() {
         cliOptions.add(CliOption.newBoolean(TARGET_OPENFEIGN,"Generate for usage with OpenFeign (instead of feign)"));
         cliOptions.add(CliOption.newBoolean(DEFAULT_INTERFACES, "Generate default implementations for interfaces").defaultValue("true"));
         cliOptions.add(CliOption.newBoolean(THROWS_EXCEPTION, "Throws Exception in operation methods").defaultValue("false"));
+        cliOptions.add(CliOption.newBoolean(DATE_PATTERN, "use pattern for date parameters").defaultValue("true"));
+        cliOptions.add(CliOption.newBoolean(DATE_TIME_PATTERN, "use pattern for date time parameters").defaultValue("true"));
 
         supportedLibraries.put(DEFAULT_LIBRARY, "Spring-boot Server application using the SpringFox integration.");
         supportedLibraries.put(SPRING_MVC_LIBRARY, "Spring-MVC Server application using the SpringFox integration.");
@@ -193,7 +197,7 @@ public void processOpts() {
         }
 
         additionalProperties.put("isJava8or11", this.java8 || this.java11);
-        this.defaultInterfaces = !(this.java8 || this.java11);
+        this.defaultInterfaces = this.java8 || this.java11;
 
         // set invokerPackage as basePackage
         if (additionalProperties.containsKey(CodegenConstants.INVOKER_PACKAGE)) {
@@ -375,6 +379,10 @@ public void processOpts() {
                         (sourceFolder + File.separator + apiPackage).replace(".", java.io.File.separator), "ApiOriginFilter.java"));
                 supportingFiles.add(new SupportingFile("swaggerDocumentationConfig.mustache",
                         (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "SwaggerDocumentationConfig.java"));
+                supportingFiles.add(new SupportingFile("LocalDateConverter.mustache",
+                    (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "LocalDateConverter.java"));
+                supportingFiles.add(new SupportingFile("LocalDateTimeConverter.mustache",
+                    (sourceFolder + File.separator + configPackage).replace(".", java.io.File.separator), "LocalDateTimeConverter.java"));
             }
         } else if ( this.swaggerDocketConfig && !isSpringCloudLibrary()) {
             supportingFiles.add(new SupportingFile("swaggerDocumentationConfig.mustache",
diff --git a/src/main/resources/handlebars/JavaSpring/LocalDateConverter.mustache b/src/main/resources/handlebars/JavaSpring/LocalDateConverter.mustache
@@ -0,0 +1,27 @@
+package {{configPackage}};
+
+import org.springframework.core.convert.converter.Converter;
+{{^isJava8or11}}
+import org.threeten.bp.LocalDate;
+import org.threeten.bp.format.DateTimeFormatter;
+{{/isJava8or11}}
+{{#isJava8or11}}
+import java.time.LocalDate;
+import java.time.format.DateTimeFormatter;
+{{/isJava8or11}}
+
+public class LocalDateConverter implements Converter<String, LocalDate> {
+    private final DateTimeFormatter formatter;
+
+    public LocalDateConverter(String dateFormat) {
+        this.formatter = DateTimeFormatter.ofPattern(dateFormat);
+    }
+
+    @Override
+    public LocalDate convert(String source) {
+        if(source == null || source.isEmpty()) {
+            return null;
+        }
+        return LocalDate.parse(source, this.formatter);
+    }
+}
diff --git a/src/main/resources/handlebars/JavaSpring/LocalDateTimeConverter.mustache b/src/main/resources/handlebars/JavaSpring/LocalDateTimeConverter.mustache
@@ -0,0 +1,27 @@
+package {{configPackage}};
+
+import org.springframework.core.convert.converter.Converter;
+{{^isJava8or11}}
+import org.threeten.bp.LocalDateTime;
+import org.threeten.bp.format.DateTimeFormatter;
+{{/isJava8or11}}
+{{#isJava8or11}}
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+{{/isJava8or11}}
+
+public class LocalDateTimeConverter implements Converter<String, LocalDateTime> {
+    private final DateTimeFormatter formatter;
+
+    public LocalDateTimeConverter(String dateFormat) {
+        this.formatter = DateTimeFormatter.ofPattern(dateFormat);
+    }
+
+    @Override
+    public LocalDateTime convert(String source) {
+        if(source == null || source.isEmpty()) {
+            return null;
+        }
+        return LocalDateTime.parse(source, this.formatter);
+    }
+}
diff --git a/src/main/resources/handlebars/JavaSpring/libraries/spring-boot/pom.mustache b/src/main/resources/handlebars/JavaSpring/libraries/spring-boot/pom.mustache
@@ -121,13 +121,13 @@
         </dependency>
 
         {{/withXml}}
-        {{#java8}}
+        {{#isJava8or11}}
 
         <dependency>
             <groupId>com.fasterxml.jackson.datatype</groupId>
             <artifactId>jackson-datatype-jsr310</artifactId>
         </dependency>
-        {{/java8}}
+        {{/isJava8or11}}
         {{#joda}}
 
         <dependency>
diff --git a/src/main/resources/handlebars/JavaSpring/libraries/spring-boot/swagger2SpringBoot.mustache b/src/main/resources/handlebars/JavaSpring/libraries/spring-boot/swagger2SpringBoot.mustache
@@ -1,5 +1,8 @@
 package {{basePackage}};
 
+import {{configPackage}}.LocalDateConverter;
+import {{configPackage}}.LocalDateTimeConverter;
+
 import org.springframework.boot.CommandLineRunner;
 import org.springframework.boot.ExitCodeGenerator;
 import org.springframework.boot.SpringApplication;
@@ -13,6 +16,10 @@ import springfox.documentation.swagger2.annotations.EnableSwagger2;
 import springfox.documentation.oas.annotations.EnableOpenApi;
 {{/useOas2}}
 
+import org.springframework.context.annotation.Configuration;
+import org.springframework.format.FormatterRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
+
 @SpringBootApplication
 {{#useOas2}}
 @EnableSwagger2
@@ -34,6 +41,15 @@ public class Swagger2SpringBoot implements CommandLineRunner {
         new SpringApplication(Swagger2SpringBoot.class).run(args);
     }
 
+    @Configuration
+    static class CustomDateConfig extends WebMvcConfigurerAdapter {
+        @Override
+        public void addFormatters(FormatterRegistry registry) {
+            registry.addConverter(new LocalDateConverter("{{#datePattern}}{{datePattern}}{{/datePattern}}{{^datePattern}}yyyy-MM-dd{{/datePattern}}"));
+            registry.addConverter(new LocalDateTimeConverter("{{#dateTimePattern}}{{dateTimePattern}}{{/dateTimePattern}}{{^dateTimePattern}}yyyy-MM-dd'T'HH:mm:ss.SSS{{/dateTimePattern}}"));
+        }
+    }
+
     class ExitException extends RuntimeException implements ExitCodeGenerator {
         private static final long serialVersionUID = 1L;
 
diff --git a/src/main/resources/handlebars/JavaSpring/libraries/spring-mvc/swaggerUiConfiguration.mustache b/src/main/resources/handlebars/JavaSpring/libraries/spring-mvc/swaggerUiConfiguration.mustache
@@ -10,6 +10,7 @@ import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.PropertySource;
 import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.Bean;
+import org.springframework.format.FormatterRegistry;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
 import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
@@ -92,6 +93,12 @@ public class SwaggerUiConfiguration extends WebMvcConfigurerAdapter {
     super.configureMessageConverters(converters);
   }
 
+  @Override
+  public void addFormatters(FormatterRegistry registry) {
+    registry.addConverter(new LocalDateConverter("{{#datePattern}}{{datePattern}}{{/datePattern}}{{^datePattern}}yyyy-MM-dd{{/datePattern}}"));
+    registry.addConverter(new LocalDateTimeConverter("{{#dateTimePattern}}{{dateTimePattern}}{{/dateTimePattern}}{{^dateTimePattern}}yyyy-MM-dd'T'HH:mm:ss.SSS{{/dateTimePattern}}"));
+  }
+
   @Bean
   public ObjectMapper objectMapper(){
     return builder().build();
