是否可以为生成的 openApi 规范文件设置特定的包名称

Question

在我们的项目（java/spring/gradle 堆栈）中，我们使用的是 openApi 规范。 我们为他们提供了一些服务和规格。 此外，我们有在每个规范中重复的通用模块。 我们将这些通用模块移动到单独的规范文件中，并将它们包含在其他文件中。 例如：

specific_project1:
   openapi:
      spec.yaml
      common_modules.yaml
   build.gradle

spec.yaml有以下代码：

openapi: 3.0.0
info:
  version: 0.0.1
paths:
  /specific/post:
    post:
      requestBody:
        context:
          application/json:
             schema:
               $ref: "common_modules.yaml#/components/schemas/TestModule"

和common_modules.yaml下一个：

openapi: 3.0.0
info:
  version: 0.0.1
components:
  schemas:
    TestModule:
      type: object
      properties:
        value:
          type: string

结果，我们需要生成带有包名spec.yaml的com.specific.project1 ，生成包名common_modules.yaml的com.common.modules并且从spec.yaml生成的生成的 java 类具有导入对于TestModule与包com.common.modules在导入。

Answer 1

对的，这是可能的

当您将 openapi 插件添加到 build.grade 时

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

您将可以访问 openApiGenerate Task ，

这可以像这样修改，例如：

openApiGenerate {
    generatorName = "jaxrs-jersey"
    inputSpec = "$rootDir/spec-v1.yaml".toString()
    outputDir = "$rootDir/".toString()
    apiPackage = "name.of.api.package.rest.server.v1.api"
    invokerPackage = "name.of.api.package.rest.server.v1.invoker"
    modelPackage = "name.of.api.package.rest.server.v1.model"
    configOptions = [
        library: "jersey2"
    ]
}

这是您可以进行的与 spring 相关的所有可能修改的链接，例如https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/spring.md

以及生成器的完整列表： https ://github.com/OpenAPITools/openapi-generator/tree/master/docs/generators

为了在一个项目中使用 2 个 yaml 文件，您必须这样做。

task common(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask){
generatorName = "spring"
inputSpec = "$rootDir//schema/common.yaml".toString()
outputDir = "$rootDir/generated".toString()
apiPackage = "com.abc.code.generated.controller"
modelPackage = "com.abc.code.generated.model"
configOptions = [
        dateLibrary: "java8"
]
systemProperties = [
    invoker : "false", 
    generateSupportingFiles: "true"
]
additionalProperties = [
    interfaceOnly : "true",
]

您可以将 openApiGenerate 保留为 spec.yaml 但请确保添加

compileJava.dependsOn common , tasks.openApiGenerate 

所以你会同时执行它们。 希望我有所帮助。

Answer 2

我们找到了如何引用同一个对象的解决方案。 我们将TestModule发布为带有自己包的单独项目，在其他项目中，我们使用importMappings配置为对象定义正确的包名称。

importMappings = [
   TestModule: "com.common.modules.TestModule"
]