将多个微服务整理成一个 swagger 2.0 规范/集合

Question

我正在使用akka-http（scala）开发微服务。目前，我找不到任何将swagger直接集成到akka-http中的内容。尽管如此，我还是以 swagger 2.0 规范开始我的微服务。

现在的挑战之一是向使用应用程序显示合并的 API 规范。我不想与消费者共享多个规格，因此希望将多个招摇的规格聚合到一个规格中（如果这可以即时完成，那就太好了）。另外，这将如何与 swagger-ui 一起工作？

Answer 1

我建议使用尽可能多的操作引用：

paths:
  health:
    $ref: "path/to/your/operation.json"

许多人构建简单的路由器以将规格组合成单个路由器，这可能非常强大：

https://router/{service}/{all-operations-from-service}

如果你有一个有效的规范文件，那么 swagger-ui 就可以了。 对于加载缓慢的超大规格，存在一些已知问题，但请考虑错误而不是 swagger-ui 的限制（这意味着它将被修复）。