从多个REST端点组装Swagger文档的最佳方法

时间:2015-10-22 11:58:35

标签: java rest documentation swagger

我正在开发一个由多个独立的REST应用程序组成的项目。 每个应用程序都有自己的Swagger JSON规范自动生成,并附带了swagger-ui模块,并显示了相应的文档。

问题是要找出一些特定的REST,我们需要手动迭代所有REST应用程序并检查它是否具有所需的端点。

我们决定将所有文档集中在一个地方,而且它应该自动完成,因为REST经常更改,手动同步所有文档真的很痛苦。

所以,我想问一下,是否有任何工具可以提供一些API,以便轻松注册Swagger端点并将它们全部显示在一个地方?

修改

我发现像“Amazon API Gateway”这样的几个API管理平台可以导入Swagger规范并显示相应的文档。但它真的是一个庞大的系统,我不认为仅将其用于文档目的是有意义的。

提前致谢

1 个答案:

答案 0 :(得分:1)

服务器端的Swagger只为单个应用程序/战争公开{war}/api-docs端点。不幸的是,没有办法将它们全部放在一起,因为它取决于你的许多应用程序细节。但是,在加载和记下战争名称时,应该非常直接地注意每个应用程序。由于您还可以访问静态HTML文件,因此您可以轻松覆盖UI以执行您需要它执行的操作。在这种情况下,你需要它

  • 点击了列出所有应用程序的自定义网络服务,例如{apps:[users, animals, core]}
  • 从已知应用程序中获取数据,而不是让用户填写信息

你真的在UI上有一些灵活性来创建一个新的登陆页面,或者只是简单地覆盖Swagger文本框作为填充应用程序等的下拉列表。