OpenAPI-为更改的api生成服务器代码?

时间:2019-02-27 20:02:32

标签: java openapi openapi-generator

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

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

虽然看起来不错,但服务器代码只是存根,然后需要大量手动插入服务。虽然这是一次性的费用,但下次我更新界面时,在我看来,唯一的两个选择是

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

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

1 个答案:

答案 0 :(得分:2)

我建议您使用API​​ First方法,该方法是在yaml文件中描述您的API并随新添加的内容生成。

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

如果您要确保文件不会被覆盖,还可以使用生成器随附的.ignore文件。