在构建Android应用程序时如何从gradle生成OpenAPI源代码

Question

我试图生成我的REST API客户端Android使用OpenAPI生成器从build.gradle脚本。这样，我就不必每次规格改变时都运行生成器命令行。理想情况下，这将在我构建/组装我的应用程序时生成，源将最终在java（生成）文件夹中，在那里生成的源可以从代码中访问（这就是BuildConfig.java文件的情况）。

下面是他们官方GitHub的链接，这里是构建。我最终得到的gradle文件：

apply plugin: 'com.android.application'
apply plugin: 'org.openapi.generator'

...

openApiValidate {
    inputSpec = "$rootDir/app/src/main/openapi/my-api.yaml"
    recommend = true
}
openApiGenerate {
    generatorName = "java"
    inputSpec = "$rootDir/app/src/main/openapi/my-api.yaml"
    outputDir = "$buildDir/generated/openapi"
    groupId = "$project.group"
    id = "$project.name-openapi"
    version = "$project.version"
    apiPackage = "com.example.mypackage.api"
    invokerPackage = "com.example.mypackage.invoker"
    modelPackage = "com.example.mypackage.model"
    configOptions = [
        java8               : "true",
        dateLibrary         : "java8",
        library             : "retrofit2"
    ]
}
...

首先，我从未尝试过通过构建/组装任务生成API，即使我尝试添加：

compileJava.dependsOn tasks.openApiGenerate

或

assemble.dependsOn tasks.openApiGenerate

我生成源代码的唯一方法是手动触发openApiGenerate任务：

然后，当我以这种方式生成源代码时，它们最终会出现在build文件夹中，但无法从我的代码中访问，并且在java（generated）文件夹中不可见：

然后，为了使用API，我必须手动将生成的源文件复制/粘贴到我的项目源中。

即使我能够通过添加手动过程来解决这些问题，如果整个过程简单地自动化，它将更容易维护。我能够实现类似的结果与另一个工具，原型。事实上，每当我构建应用程序时，我的gradle任务都会被触发，源代码最终会出现在java（生成的）文件夹中，所以我不必做任何额外的工作。不过，这个任务要简单得多，所以我假设我不能用OpenAPI生成器复制的主要工作是由原型插件本身处理的。

Answer 1

您必须将生成源的路径指定为Gradle模块的自定义源集，在本例中为app，如下所述-https://developer.android.com/studio/build/build-variants#configure-源集。这样，Gradle会将您的源代码视为可从您的代码访问。

大概是这样的：

android {
  ...
  sourceSets {
    main {
      java.srcDirs = ['build/generated/openapi/src/main/java']
    }
  }
  ...
}