生成API的最佳方式是招摇过市？i、 e.codegen vs swagger编辑器（Spring Boot API）

Question

我正在开发一个有点传统的API（Spring Boot）——它使用的是openapi 2.0版，它还使用pom中的swagger-codegen-maven插件插件。xml。

我最近参加了一个领英学习课程，我们使用斯瓦格编辑器（本地使用Docker）编写api规范（openapi 3.0），并用您选择的任何语言“导出”服务器存根，在这种情况下JavaSpring。我注意到Controller实现的API类已经在这个存根中生成了。然而，当使用swagger-codemen-maven-plugin时，这些接口直到编译项目（mvn安装）才会生成，这与您定义的任何数据结构的模式相同，例如，在swagger yaml的定义部分中的请求体。

我想询问构建API的首选方法是什么——是通过web GUI使用Swagger编辑器，还是本地使用，然后用YAML编写规范，然后用您选择的语言/框架导出服务器存根，还是在本地手动编写一些类（即使您添加了swagger yaml，看起来仍然需要为控制器等编写代码。使用此方法，如果我错了，请纠正我）即IntelliJ使用Spring，然后将swagger codegen maven插件添加到您的项目中，并让它为您生成接口/具体类？

Answer 1

我更喜欢使用Maven插件。

在Maven生命周期的编译阶段生成服务器存根没有错：运行它，获取存根并开始使用它们。

Maven插件的优点是您可以配置生成器的输出：例如，您可以设置包名称、模型名称的后缀或前缀，无论您是只想生成接口还是存根实现。

这里是maven插件配置的完整列表，您可以在这里找到特定于Spring的选项。据我所知，使用Swagger web生成器，您无法配置任何内容。

使用maven插件时唯一要记住的是不要手动修改生成的代码，否则每次再次运行它时，都会丢失手动更改。因此，您的实际实现代码将需要实现生成的API接口或扩展生成的API控制器。或者更好地生成delegatePattern选项设置为true的代码，并实现生成的委托接口。