使用openapi生成器gradle插件仅为Spring Boot生成REST接口

Question

我试图从我们需要实现的一个招摇过市的文件中生成接口。它是从外部来源提供的。我通常先使用契约，但在java/kotlin中很长一段时间没有这样做。

我已经建立了一个项目，希望尽可能多地控制我的代码。我尝试使用openapi生成器gradle插件和kotlin-spring或springgenerator来生成接口（导入部分）。

最好是带有Spring相关注释的接口（UrestMaps等），至少是接口。但看起来，生成器还会生成一个小应用程序（带有gradle/maven文件、SpringBootApp、README. md...）。

我没有代码了，但我很确定，上次我这样做的时候，很容易生成接口，但不记得我使用了哪个生成器或插件。

所以我的问题是，我是否错过了什么，或者只是创建接口不再是问题了？大家都想在这里搭脚手架吗？




Answer 1

如果您使用gradle与build.gradle.kts，您可以使用这个openapi生成器插件任务来生成swagger代码。它做同样的事情作为昂首阔步codemen插件：

plugins {
    id("org.openapi.generator") version "5.1.1"
}

openApiGenerate {
    generatorName.set("spring")
    inputSpec.set("$rootDir/src/main/resources/petstore.yaml")
    outputDir.set("$buildDir/generated/")
    configFile.set("$rootDir/src/main/resources/api-config.json")


    globalProperties.set(mapOf(
        Pair("apis", ""), //no value or comma-separated api names
        Pair("models", ""), //no value or comma-separated api names
    ))
}

从您的招摇过市中的路径生成的api。api配置。json具有生成器的设置。然后，您需要通过执行以下操作将生成的类添加到源集中：

configure<SourceSetContainer> {
    named("main") {
        java.srcDir("$buildDir/generated/src/main/java")
    }
}

最后，请确保在编译之前生成swagger文件：

tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
    dependsOn("openApiGenerate")
    kotlinOptions.jvmTarget = "11"
}

Answer 2

我添加了以下属性到我的openApiGenerate任务：

    globalProperties =[
            apis: '',
            models: '',
    ]

这为我解决了问题。

Answer 3

我将openapi生成器maven插件与

<plugin>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <version>5.0.0-beta</version>
  <executions>
    <execution>
      <id>1</id>
      <goals>
        <goal>generate</goal>
      </goals>
      <configuration>
        <inputSpec>openapi.json</inputSpec>
        <generatorName>spring</generatorName>
        <modelPackage>modelPackage</modelPackage>
        <apiPackage>apiPackage</apiPackage>
        <invokerPackage>invokerPackage</invokerPackage>
        <configOptions>
          <sourceFolder>target</sourceFolder>
          <interfaceOnly>true</interfaceOnly>
        </configOptions>
      </configuration>
    </execution>
  </executions>
</plugin>