时间戳

首页 > 解决方案 > 如何正确使用 Swagger Maven 插件和现有项目

java - 如何正确使用 Swagger Maven 插件和现有项目

问题描述

我有一个使用 Spring-MVC 的现有 Jetty 项目。我现在引入了 swagger 来创建一个带有新 API 规范文件的 .yaml 文件（API 的 v2，因为我必须编写新的 API，由于遗留原因而单独留下现有的 API）。

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

这是正确的做法吗？

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

标签： javamavenswagger

解决方案

为什么要签入每次触摸输入文件时生成的源文件？这意味着，如果您更改输入文件，您总是会有多余的提交。但更糟糕的是，另一位开发人员（不熟悉您的解决方案）可能会认为源文件夹中有 java 代码，所以他可以在那里做一些小改动来解决问题。它甚至可以在他的本地机器上运行。但是在推入您的 SCM 并在构建服务器上构建完整的 maven 之后，他的更改将消失。

推荐阅读