建立Android应用程式时如何从Gradle产生OpenAPI来源

问题描述

我要实现的目标

我正在尝试从 build.gradle 脚本使用OpenAPI Generator生成Android的REST API客户端。这样，我不必每次更改规格时都运行生成器命令行。理想情况下，这将在我构建/组装应用程序时生成，并且源代码最终存储在 java（生成的）文件夹中，然后可以从代码中访问生成的源代码（例如 BuildConfig.java 文件）。

到目前为止我已经尝试过的

在此link from their official GitHub之后，这是我最后得到的 build.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"
    ]
}
...

首先，即使尝试添加，我也从未设法通过build / assembly任务生成API。

compileJava.dependsOn tasks.openApiGenerate

或

assemble.dependsOn tasks.openApiGenerate

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

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

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

即使我可以通过添加手动过程来解决这些问题，但是如果整个过程都是自动的，那么它将更具维护性。使用另一个工具Protobuf，我可以达到类似的结果。确实，我每次构建应用程序时都会触发gradle任务，并且源代码最终保存在 java（生成的）文件夹中，因此我无需执行任何其他工作。不过，该任务要简单得多，因此我认为Protobuf插件本身可以处理无法使用OpenAPI Generator复制的主要工作。

解决方法

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

像这样：

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