如何将OpenAPI客户端添加为子项目？

Question

我可以通过源代码集成功地将生成的openapi客户端添加到我的项目中。但是我必须将依赖项复制到主build-gradle中，解决冲突-

所以我添加包括='build： openapi-java-Client'到我的settings.gradle和编译项目（'： build： openapi-java-Client'）到我的依赖项。这样我就有了以下文件：
build.gradle：

plugins {
    id 'java'
    id 'application'
    id "org.openapi.generator" version "4.3.1"
}

repositories {
    jcenter()
}

openApiGenerate {
    generatorName = "java"
    inputSpec = "$rootDir/specs/petstore.yaml".toString()
    outputDir = "$buildDir/openapi-java-client".toString()
    apiPackage = "org.openapi.example.api"
    invokerPackage = "org.openapi.example.invoker"
    modelPackage = "org.openapi.example.model"
    configOptions = [
        dateLibrary: "java8"
    ]
}

dependencies {
    implementation 'com.google.guava:guava:29.0-jre'
    testImplementation 'junit:junit:4.13'
    
    compile project(':build:openapi-java-client')
}

application {
    mainClassName = 'a.aa.App'
}

和设置。格雷德尔：

rootProject.name = 'simple-java-app'
include = 'build:openapi-java-client'

我预先执行openApiGenerate，在将其作为子项目添加之后，我执行Gradle-

然后，Eclipse向我展示了一个问题：

Could not run phased build action using Gradle distribution 'https://services.gradle.org/distributions/gradle-6.5.1-bin.zip'.
Settings file 'C:\...\simple-java-app\settings.gradle' line: 11
A problem occurred evaluating settings 'simple-java-app'.
Could not set unknown property 'include' for settings 'simple-java-app' of type org.gradle.initialization.DefaultSettings.

我不知道从这里去哪里，寻址子文件夹中的子项目工作得很好，当我通过https://guides.gradle.org/creating-multi-project-builds/并把问候库放在子文件夹中时。

Answer 1

我刚刚回答了一个非常类似的问题。虽然我的答案并不完美，但我个人还是更喜欢那里建议的方法——这里也有重复：

我将保持依赖于生成的API的模块的构建与生成API的构建完全分开。这种构建之间的唯一连接应该是依赖项声明。这意味着，您必须手动确保首先构建API生成项目，然后只构建依赖的项目。

默认情况下，这意味着在构建依赖项目之前也要发布API模块。此默认设置的替代方法是Gradle复合构建，例如，允许您在发布新生成的API之前先在本地测试它。但是，在创建/运行复合构建之前，您必须在每次OpenAPI文档更改时手动运行API生成构建。

假设项目A取决于生成的API。它的Gradle构建将包含这样的内容：

dependencies {
    implementation 'com.example:api:1.0'
}

当然，问题中描述的simple java app构建必须进行调整，以生成具有以下坐标的模块：

openApiGenerate {
    // …
    groupId = "com.example"
    id = "api"
    version = "1.0"
}

在运行A的构建之前，你必须先运行

1. /gradlew openApiGenerate来自您的简单java应用程序项目
2. /gradlew从simple java app/build/openapi java client/目录发布

然后，A的构建可以从发布存储库获取已发布的依赖项。

或者，您可以在本地删除步骤2，并使用附加的Gradle CLI选项运行A的构建：

./gradlew --include-build $path_to/simple-java-app/build/openapi-java-client/ …

Answer 2

您不能这样配置它，因为build肯定是一个输出目录，它将创建一个循环引用。最好尝试添加一个新模块，并将生成器插件添加到该模块中。如果您可以将另一个模块配置为outputDir，则可以引用该模块。

即使插件驻留在根项目中，目标也需要是一个模块。

关键是，根项目总是执行，与模块配置相反。

Answer 3

您正试图使build/成为一个项目，而该目录并不意味着是一个项目目录。它是Gradle默认构建目录，可能是99%的其他插件和其他Gradle插件。

只需将输出目录更改为build/以外的内容：

openApiGenerate {
    generatorName.set("java")
    inputSpec.set("$rootDir/specs/petstore.json")
    outputDir.set("$rootDir/openapi-java-client")
    apiPackage.set("org.openapi.example.api")
    invokerPackage.set("org.openapi.example.invoker")
    modelPackage.set("org.openapi.example.model")
}

然后使用正确的语法将项目包括在生成中：

// settings.gradle
include("openapi-java-client")

但是，使用org。openapi。生成器似乎生成了无效的生成。gradle因为我得到以下错误：

FAILURE: Build failed with an exception.

* Where:
Build file 'C:\Users\fmate\code\example\openapi-java-client\build.gradle' line: 23

* What went wrong:
Could not compile build file 'C:\Users\fmate\code\example\openapi-java-client\build.gradle'.
> startup failed:
  build file 'C:\Users\fmate\code\example\openapi-java-client\build.gradle': 23: unexpected char: '\' @ line 23, column 35.
         main.java.srcDirs = ['src/main\java']

这显然不会像你希望的那样工作，因为它似乎是Gradle插件本身的一个问题。如果您只需要在项目中包含生成代码，那么只需将生成的Java代码作为主Java的一部分：

openApiGenerate {
    generatorName.set("java")
    inputSpec.set("$rootDir/specs/petstore.json")
    outputDir.set("$buildDir/openapi-java-client")
    apiPackage.set("org.openapi.example.api")
    invokerPackage.set("org.openapi.example.invoker")
    modelPackage.set("org.openapi.example.model")
}

tasks {
    compileJava {
        dependsOn(openApiGenerate)
    }
}

sourceSets {
    main {
        java {
            srcDir(files("${openApiGenerate.outputDir.get()}/src/main"))
        }
    }
}

但是使用这种方法，您将遇到缺少导入/依赖项的情况。该插件似乎不提供仅生成模型/POJO的功能，因此将库属性更新为本机，并手动包含一些缺少的依赖项，这一切都可以工作：

plugins {
    java
    id("org.openapi.generator") version "5.0.0-beta"
}

repositories {
    mavenCentral()
}

group = "io.mateo.test"

dependencies {
    implementation(platform("com.fasterxml.jackson:jackson-bom:2.11.1"))
    implementation("com.fasterxml.jackson.core:jackson-databind")
    implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310")
    implementation("org.openapitools:jackson-databind-nullable:0.2.1")
    implementation("com.google.code.findbugs:jsr305:3.0.2")
    implementation("io.swagger:swagger-core:1.6.2")
}

openApiGenerate {
    generatorName.set("java")
    inputSpec.set("$rootDir/specs/petstore.json")
    outputDir.set("$buildDir/openapi-java-client")
    apiPackage.set("org.openapi.example.api")
    invokerPackage.set("org.openapi.example.invoker")
    modelPackage.set("org.openapi.example.model")
    library.set("native")
    configOptions.put("dateLibrary", "java8")
}

tasks {
    compileJava {
        dependsOn(openApiGenerate)
    }
}

sourceSets {
    main {
        java {
            srcDir(files("${openApiGenerate.outputDir.get()}/src/main"))
        }
    }
}