java - 从多个 REST 端点组装 Swagger 文档的最佳方式

标签 java rest documentation swagger

<分区>

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

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

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

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

编辑:

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

提前致谢

最佳答案

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

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

您在 UI 上确实有一些灵 active 来创建新的登录页面,或者只是简单地覆盖 Swagger 文本框,使其成为一个下拉列表,用于填充应用程序等。

关于java - 从多个 REST 端点组装 Swagger 文档的最佳方式,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/33280488/

相关文章:

java - 在 Java 中,努力返回颜色

java - 初始化默认 SSL 上下文失败

REST 风格的 API : How to organize nested resources

wcf - WCF Rest 服务的 SSL 实现

javascript - 如何将 jsdoc 用于 meteor 应用程序

python - 安装 Python 包文档

javascript - 生成 Javascript 文档

java - 调用 line.isEmpty() 方法时出现重复的答案输出

Java 按钮未出现在(GUI)上

java - Android 可以执行 Activity 的方法