如何将Swagger Maven插件正确用于现有项目

时间:2019-02-07 00:39:54

标签: java maven swagger

我有一个使用Spring-MVC的现有Jetty项目。 我现在介绍了用swagger创建带有新API规范文件的.yaml文件(因为我必须编写新的API,因此第2版的API,由于遗留原因,不使用现有的API)。

我已经设置了swagger-maven-plugin(https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen-maven-plugin),以将模型和API接口生成到我的src / main文件夹中。

这是否是正确的方法?

默认情况下,它将这些文件生成到目标/自动生成的文件夹中,我不明白为什么

1 个答案:

答案 0 :(得分:0)

您为什么要检入生成的源文件,这些源文件在您每次触摸输入文件时都会生成?这意味着,如果您更改输入文件,则始终具有冗余提交。但是更糟糕的是,另一个开发人员(不熟悉您的解决方案)可能会认为源文件夹中包含Java代码,因此他可以在此处进行一些小的更改以解决问题。它甚至可以在他的本地计算机上工作。但是在将您的SCM和完整的Maven构建推入构建服务器之后,他的更改将消失。