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

时间:2019-08-12 16:07:01

标签: openapi-generator

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

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

但是,生成了一些我不需要的其他文件,例如README.md.openapi-generator/VERSION.openapi-generator-ignore

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

2 个答案:

答案 0 :(得分:1)

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

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

答案 1 :(得分: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