如果休息端点正在消耗外部休息端点,Swagger /其他API文档/工具能否提供信息?

时间:2019-02-28 11:21:14

标签: rest web-services swagger-ui swagger-2.0 api-doc

最近不得不对系统(在微服务架构中)的其余端点进行分析,这些系统在内部消耗外部的其余端点。这些端点属于其他微服务或第三方Web服务。

只是想知道是否可以定制Swagger来实现此目的,或者是否有其他工具可以帮助我收集或可视化此信息。

1 个答案:

答案 0 :(得分:1)

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

如果您想实时查看您的服务正在消耗哪些端点,请查看New Relics - Service MapInstana - Dependency Maps。我敢肯定其他APM工具也可以做到这一点,但这是我所知道的两个。这些的缺点是它们不是免费的。

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