【问题标题】:How to generate Swagger json/yaml files from static code (Java)?如何从静态代码(Java)生成 Swagger json/yaml 文件?
【发布时间】:2018-03-22 14:44:00
【问题描述】:

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

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

【问题讨论】:

  • 我不知道它是否存在,但是你使用像spring这样的框架吗?如果是,值得一提,如果不是,我认为不存在解决方案
  • @Kepotx 不,我们没有使用 Spring。这是一个带有 Maven 项目的 Java SE。

标签: java automation continuous-integration swagger


【解决方案1】:

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

另一种方式是,如果你做相反的事情,你首先在大摇大摆地设计你的 API 接口,然后你生成代码(你的接口),然后你自己实现。

从听起来你想首先设计你的 API,这将允许你把它放在版本控制中,这将使你更容易管理你的 API 版本生命周期和跟踪它的变化,否则它可能会很如果您必须在代码中搜索带注释的方法,很难看出事情发生了什么变化,这就是 swagger 的设计目的。

您不一定需要大摇大摆地进行代码生成,因为我发现这有时非常尴尬,而且它非常愚蠢并且生成代码,它只是胡须模板,IMO 该工具因此存在根本缺陷,但正如我最讨厌的一句话:

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

【讨论】:

    猜你喜欢
    • 2016-03-24
    • 2019-06-24
    • 1970-01-01
    • 2019-04-09
    • 2021-01-07
    • 1970-01-01
    • 2019-10-30
    • 2016-12-11
    • 1970-01-01
    相关资源
    最近更新 更多