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

Question

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

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

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

Answer 1

您可以使用 swagger.io标签来做到这一点

例如，在 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)，其中包含两个类中的所有方法。