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

Question

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

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

规范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"

和公共_模块。yaml下一个：

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

因此，我们需要用包名com生成spec.yaml。具体的项目1，通用_模块。yaml是用包名com生成的。常见的模块和从spec.yaml生成的java类具有对带有包的TestModule的导入。常见的导入中的模块。




Answer 1

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

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

Answer 2

是的，这是可能的

当您添加openapi插件进行构建时。等级式

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

您可以访问openApiGenerate任务，

可以这样修改，例如：

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",
]

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

compileJava.dependsOn common , tasks.openApiGenerate 

所以你要同时执行这两个命令。希望我能帮上忙。