12

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

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

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

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

4

3 回答 3

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"
        )
    }
}
于 2021-10-11T19:57:48.340 回答
0

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

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

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

于 2019-09-04T14:31:25.260 回答
0

是的，这可以使用 .openapi-generator-ignore 文件，如以下文件所述：

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

例如，要跳过 git_push.sh，可以在输出目录的根目录中创建一个名为 .openapi-generator-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

于 2020-12-28T15:53:18.920 回答