如何配置open-api-generator生成代码时跳过@DateTimeFormat注解
OpenAPI Generator 6.0.1 禁用日期字段自动生成@DateTimeFormat注解配置方法
@DateTimeFormat注解是OpenAPI Generator的Spring系列代码生成器默认给日期/时间类型字段添加的Spring参数绑定注解,可通过以下两种方式在生成阶段跳过该注解的自动添加:
方案1:直接配置插件全局开关(推荐)
在插件配置的configOptions节点下,将useDateTimeFormatAnnotation参数设置为false即可全局关闭该注解的自动生成,不需要修改模板。
- Maven插件配置示例:
<plugin> <groupId>org.openapitools</groupId> <artifactId>openapi-generator-maven-plugin</artifactId> <version>6.0.1</version> <executions> <execution> <goals> <goal>generate</goal> </goals> <configuration> <inputSpec>${project.basedir}/src/main/resources/your-api.yaml</inputSpec> <generatorName>spring</generatorName> <configOptions> <!-- 关闭日期字段自动添加@DateTimeFormat注解 --> <useDateTimeFormatAnnotation>false</useDateTimeFormatAnnotation> <!-- 其他原有配置保持不变 --> </configOptions> </configuration> </execution> </executions> </plugin>
- Gradle插件配置示例:
openApiGenerate { inputSpec = "$rootDir/src/main/resources/your-api.yaml" generatorName = "spring" configOptions = [ useDateTimeFormatAnnotation: "false", // 其他原有配置保持不变 ] }
注意:该配置项对spring、spring-cloud等所有基于Spring的生成器生效,6.0.1版本已原生支持该参数,不需要升级插件版本。
方案2:自定义模板覆盖默认逻辑(适配特殊定制场景)
如果你的工程使用了自定义生成模板,全局开关不生效,可以直接覆盖对应模板片段:
- 从OpenAPI Generator 6.0.1的官方模板仓库中复制对应生成器的
pojo.mustache、beanValidation.mustache模板文件到你的工程自定义模板目录 - 找到模板中判断类型为
LocalDate、LocalDateTime、Date等日期类型时渲染@DateTimeFormat的代码块,直接删除该部分逻辑 - 在插件配置中通过
templateDirectory参数指定你的自定义模板路径,生成时就会用修改后的模板渲染,不会再输出该注解。
如果仅需要对部分特定日期字段移除该注解,不需要全局关闭,可以在OpenAPI YAML文件对应字段上添加x-field-extra-annotation扩展属性,覆盖默认注解生成规则即可。
内容的提问来源于stack exchange,提问作者user3212324
相关产品推荐
相关产品推荐

