一个Swagger文件中包含多个API文档

Question

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

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

因为我开发了2个REST API，我想拥有一个通用的swagger UI，而不是两个，我可以通过像Tyk这样的网关进行管理。

- victorio

---

是的，您可以为多个API定义拥有单个Swagger UI。请参见如何为包含多个Swagger定义.json/.yml文件的目录组织/构建Swagger UI界面和具有多个URL的Swagger UI。 - Helen

几乎，但那些答案都在谈论index.html的更改。但是这里我没有index.html文件，只有yaml本身。 - victorio

类似这样吗？在“/{path}”级别覆盖“host”和“basePath”，OpenAPI 3.0中的servers属性有什么重要性？ - Helen

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），其中包含来自两个类的所有方法。

- Nikola Andreev