如何用openapi-generator-maven-plugin的typeMappings将LocalDate/OffsetDateTime转为Instant

问题场景 #

使用openapi-generator-maven-plugin的jaxrs-spec生成器生成代码时：

• API接口MaintenanceWindowsAvrApi的day参数被生成为LocalDate类型
• DTO类MaintenanceWindowAVRDto的start、end字段被生成为OffsetDateTime类型

需要通过插件配置将上述类型统一替换为java.time.Instant。

可行配置方案 #

在openapi-generator-maven-plugin的配置中，需同时配置typeMappings、importMappings并指定dateLibrary，完整配置示例如下：

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>请替换为你的插件版本</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <inputSpec>${project.basedir}/src/main/resources/你的openapi规范文件.yaml</inputSpec>
                <generatorName>jaxrs-spec</generatorName>
                <!-- 类型映射：将目标类型替换为Instant -->
                <typeMappings>
                    <typeMapping>LocalDate=Instant</typeMapping>
                    <typeMapping>OffsetDateTime=Instant</typeMapping>
                </typeMappings>
                <!-- 导入映射：确保生成代码时正确导入Instant类 -->
                <importMappings>
                    <importMapping>java.time.LocalDate=java.time.Instant</importMapping>
                    <importMapping>java.time.OffsetDateTime=java.time.Instant</importMapping>
                </importMappings>
                <!-- 指定日期库为java8，确保类型映射逻辑生效 -->
                <dateLibrary>java8</dateLibrary>
                <!-- 其他自定义配置（如包名、输出目录等） -->
                <packageName>com.your.package</packageName>
                <output>${project.build.directory}/generated-sources/openapi</output>
            </configuration>
        </execution>
    </executions>
</plugin>

关键配置说明 #

1. typeMappings：直接指定生成代码时的类型替换规则，将LocalDate和OffsetDateTime替换为Instant
2. importMappings：解决类型替换后的导入路径问题，确保生成的代码中正确导入java.time.Instant而非原类型
3. dateLibrary=java8：明确使用Java 8的日期时间API，避免默认日期库导致的映射逻辑冲突

验证步骤 #

执行以下命令重新生成代码：

mvn clean compile

检查生成的文件：

• MaintenanceWindowsAvrApi.java中day参数的类型应为Instant
• MaintenanceWindowAVRDto.java中start、end字段的类型应为Instant

内容的提问来源于stack exchange，提问作者CoderOfTheForce