rest - 一个 Swagger 文件中的多个 API 文档

Question

是否可以有多个(以某种方式分开的)REST API 文档，但只能在一个 swagger yaml 文件中？

或者 swagger yaml 可以只包含一个 API 文档吗？

因为我有 2 个由我开发的 REST API，我想要一个通用的 swagger ui 而不是两个，我可以用像 Tyk 这样的网关来管理。

Answer 1

你可以用 swagger.io tags
例如在 spring (springfox-swagger) 中，您只需要在多个 API 类上放置相同的标签，它就会在 swagger UI 中将它们合并为一组。

@Api(value = "First API", tags = {"first-api"})  
public class FirstApi { ... }

@Api(tags = {"first-api"})  
public class SecondApi { ... }

在 swagger UI 中，您只会看到一个 API(first-api)，其中包含来自两个类的所有方法。