【问题标题】:OpenAPI - generate server code for a changing api?OpenAPI - 为不断变化的 api 生成服务器代码?
【发布时间】:2019-02-27 20:02:32
【问题描述】:

我正在维护一个 Java 应用程序,我们在其中不断添加新功能(API 中的更改)。我想转向使用 OpenAPI 作为记录 api 的一种方式。我看到了两种思想流派:

  1. 编写代码,使用一些注释来生成 OpenAPI 规范。
  2. 编写 OpenAPI,用它来生成一些服务器代码。

虽然两者看起来都很好,但服务器代码只是简单地存根,然后需要大量手动插入服务。虽然这似乎是一次性成本,但下次我更新界面时,在我看来只有两个选项

  1. 再次生成它们,重新进行所有手动接线。
  2. 手动编辑之前生成的类以匹配新的规范文件(可能会引入错误)。

我对这些选项是否正确?如果是这样,似乎使用代码生成 api spec 文件确实是唯一明智的选择。

【问题讨论】:

    标签: java openapi openapi-generator


    【解决方案1】:

    我会推荐一种 API First 方法,您可以在 yaml 文件中描述您的 API,并在每次添加新内容时生成。

    现在您如何处理生成器覆盖手动工作? 您可以使用继承来根据生成的代码创建模型和控制器。

    如果您想确保文件不会被覆盖,您也可以使用生成器提供的 .ignore 文件。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2019-08-30
      • 2020-02-17
      • 1970-01-01
      • 2011-02-15
      • 2022-07-02
      • 2020-10-18
      • 2020-02-10
      • 2019-12-07
      相关资源
      最近更新 更多