如果rest端点正在使用外部rest端点，Swagger/其他API文档/工具能否提供信息

Question

最近不得不对系统(在微服务架构中)中的rest端点进行分析，这些端点在内部使用外部rest端点。这些端点要么属于其他微服务，要么属于第三方web服务。

我很好奇是否可以定制Swagger来实现这一点，或者是否有任何其他工具可以帮助我收集或可视化这些信息。

Answer 1

浏览一下OpenAPI Spec (以前称为Swagger文件)，它看起来不像是定义了连接的端点。这是有道理的，因为它的目的是定义API的接口，而不是它的底层实现。但是，它确实提供了一种使用External Documentation Object链接到外部文档的方法。这可以链接到有关给定API使用哪些端点的文档。

如果您想实时了解您的服务正在使用哪些端点，可以查看New Relics - Service Map和Instana - Dependency Maps。我相信其他APM工具也可以做到这一点，但这是我所知道的两个。它们的缺点是它们不是免费的。

另一种方法是编写一个工具来解析您的配置文件，查找所有外部依赖项。当然，这需要在您的服务中使用标准和命名约定来标识这些端点。