Gradle执行openApiGenerate时提示‘Generator name must be specified’错误排查

我在使用OpenAPI生成REST API服务端代码时遇到异常：执行默认的openApiGenerate任务时会报错Cause: Generator name must be specified，但自定义的buildJavaResttemplateSdk任务却能正常运行。当前的Gradle配置如下：

buildscript {
    repositories {
        mavenLocal()
        maven { url "https://repo1.maven.org/maven2" }
        maven {
            url "https://plugins.gradle.org/m2/"
        }
        maven {
            url "https://oss.sonatype.org/content/repositories/releases/"
        }
        maven {
            url "https://oss.sonatype.org/content/repositories/snapshots/"
        }
    }
    dependencies {
        // Updated version can be passed via command line arg as -PopenApiGeneratorVersion=VERSION
        classpath "org.openapitools:openapi-generator-gradle-plugin:$openApiGeneratorVersion"
    }
}

apply plugin: 'org.openapi.generator'

openApiMeta {
    generatorName = "Sample"
    packageName = "org.openapitools.example"
    outputFolder = "$buildDir/meta".toString()
}

openApiValidate {
    inputSpec = "$rootDir/petstore-v3.0-invalid.yaml".toString()
    recommend = true
}

openApiGenerate {
    generatorName = "spring"
    inputSpec = "$rootDir/petstore-v3.0.yaml".toString()
    outputDir = "$buildDir/spring-api".toString()
    apiPackage = "org.openapitools.example.api"
    invokerPackage = "org.openapitools.example.invoker"
    modelPackage = "org.openapitools.example.model"
    configOptions = [
            dateLibrary: "java8"
    ]
    globalProperties = [
            modelDocs: "false"
    ]
    skipValidateSpec = true
    logToStderr = true
    generateAliasAsModel = false
    // set to true and set environment variable {LANG}_POST_PROCESS_FILE
    // (e.g. SCALA_POST_PROCESS_FILE) to the linter/formatter to be processed.
    // This command will be passed one file at a time for most supported post processors.
    enablePostProcessFile = false
}

task buildJavaResttemplateSdk(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask) {
    generatorName = "java"
    library = "resttemplate"
    inputSpec = "$rootDir/petstore-v3.0.yaml".toString()
    outputDir = "$buildDir/java-resttemplate-api-client"
    apiPackage = "com.example.client"
    invokerPackage = "com.example.invoker"
    modelPackage = "com.example.cdm"
    configOptions = [
            dateLibrary: "java8"
    ]
    groupId = 'com.example'
    id = 'client'
    skipValidateSpec = true
    logToStderr = true
    generateAliasAsModel = false
    enablePostProcessFile = false
}

原因分析 #

这个问题的核心原因是OpenAPI Generator Gradle插件的版本兼容性或配置加载逻辑差异：

• 自定义任务显式声明了type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask，任务类型明确，配置的generatorName等参数能被正确解析加载。
• 默认的openApiGenerate任务在部分新版本插件（如6.x及以上）中，配置绑定逻辑发生变更，导致直接配置的generatorName未被正确注入到任务实例中，触发必填参数缺失的错误。

解决方法 #

方法1：显式指定openApiGenerate任务的类型 #

修改默认任务配置，明确声明任务类型，确保配置参数被正确识别：

openApiGenerate(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask) {
    generatorName = "spring"
    inputSpec = "$rootDir/petstore-v3.0.yaml".toString()
    outputDir = "$buildDir/spring-api".toString()
    apiPackage = "org.openapitools.example.api"
    invokerPackage = "org.openapitools.example.invoker"
    modelPackage = "org.openapitools.example.model"
    configOptions = [
            dateLibrary: "java8"
    ]
    globalProperties = [
            modelDocs: "false"
    ]
    skipValidateSpec = true
    logToStderr = true
    generateAliasAsModel = false
    enablePostProcessFile = false
}

方法2：锁定稳定的插件版本 #

如果是版本兼容性问题，尝试锁定一个经过验证的稳定版本：

• 命令行临时指定版本：./gradlew openApiGenerate -PopenApiGeneratorVersion=5.4.0
• 或者在buildscript中硬编码版本号：

classpath "org.openapitools:openapi-generator-gradle-plugin:5.4.0"

方法3：使用插件DSL配置语法（适用于新版本插件） #

对于6.x及以上版本的插件，推荐使用Gradle插件DSL方式引入插件，确保配置绑定逻辑正确：

plugins {
    id "org.openapi.generator" version "6.6.0"
}

// 原openApiGenerate配置保持不变
openApiGenerate {
    generatorName = "spring"
    inputSpec = "$rootDir/petstore-v3.0.yaml".toString()
    // 其他配置项...
}

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