如何从静态代码(Java)生成Swagger json / yaml文件?

时间:2018-03-22 14:44:00

标签: java automation continuous-integration swagger

是否有任何库可以通过分析静态代码并从中生成JSON / YAML文件来生成JSON / YAML文件?

现在,一旦项目完成构建,我们就会生成Swagger文件。我们点击了/api/swagger.yaml上的网址并使用该文件执行了我们需要的操作(这为我们的自动构建增加了相当多的复杂性)

1 个答案:

答案 0 :(得分:0)

是的,因为你已经在做了,你可以坚持你的CI,这将启动这个虚拟的Spring应用程序然后发出HTTP请求下载JSON / YAML然后关闭它并获取文件,就我而言我知道在Java的编译时没有工具可以做到这一点,并且它就像它一样好。

另一种方法是,如果你在第一个设计API接口的对面做事,然后生成代码(你的接口)然后自己实现。

从它的声音中你想要首先设计你的API,这将允许你把它放在版本控制中,这将使你更容易管理你的API版本生命周期并跟踪它的变化,否则它可能是相当的如果你必须在代码中搜索带注释的方法,很难看出事情是如何变化的,那就是swagger的设计目的。

你不一定需要从你的招摇中做codegen,因为我发现它有时非常笨拙而且非常愚蠢并且生成代码,它只是小胡子模板和IMO工具从根本上是有缺陷的,因此,但正如我最讨厌的说法那样:

  

它是免费的,所以你不能抱怨