如何使用openAPI生成器和Maven跳过支持和元数据文件的生成？

Question

我正在使用Maven的openapi-yaml生成器将一个swagger文件转换为一个开放的API v3文件。

我想要做的是将新文件直接放到某个目录中。

但是会生成一些我不需要的附加文件，例如README.md、.openapi-generator/VERSION、.openapi-generator-ignore

是否可以禁用此行为并仅生成.yaml文件？

Answer 1

是的，这是可以使用.openapi生成器-忽略文件的，如下面的文档所示：

https://github.com/OpenAPITools/openapi-generator/blob/master/docs/customization.md#ignore-file-format

例如，要跳过生成器，可以在输出目录的根目录中创建一个名为.openapi- git_push.sh -ignore的文件，其中包含以下内容：

# Prevent generator from creating these files:
git_push.sh

还可以在以下位置找到一些很好的文档：

https://openapi-generator.tech/docs/faq-extending/#how-do-i-skip-files-during-code-generation

Answer 2

直接通过openApiGenerate配置看起来仍然是不可能的。正如其他人所建议的，这可以通过一个脚本来完成。由于没有示例，下面是我通过扩展gradle任务组合而成的内容

openApiGenerate {
    generatorName = "java"
    inputSpec = (String) "$buildDir/openapi.json"
    outputDir =  (String) "$rootDir/generated-client"
    apiPackage = "com.example.client.api"
    modelPackage = "com.example.client.model"
    invokerPackage = "com.example.client.invoker"
}

tasks.openApiGenerate {
    doLast {
        delete (
                "$rootDir/generated-client/.openapi-generator",
                "$rootDir/generated-client/api",
                "$rootDir/generated-client/gradle",
                "$rootDir/generated-client/docs"
        )
    }
}

Answer 3

我建议你保留这些文件。README.md可以帮助其他人理解代码。版本显示您正在使用的openapi生成器的版本。.openapi-generator-ignore的工作原理与.gitignore类似，可以跳过生成的某些文件

将README.md和.openapi-generator/VERSION放在.openapi-generator-ignore中将跳过这些文件的生成。

要“忽略”.openapi生成器文件夹，您可以使用脚本对输出进行后处理，并删除不需要的文件/文件夹。