使用 Swagger Inspector 扩展监控私有 API

  2019 年 2 月 14 日

了解生产环境中内部 API 的性能似乎是一项艰巨的任务。事实上,直到最近,大多数团队都没有积极监控他们的 API。随着近期市场变化,越来越多的团队将 API 监控作为其运维团队和质量保证团队的优先事项,以确保每次发布都经过适当测试,并设置监控以确保此性能在生产环境中持续。我们在 2019 年 API 现状调查中发现,将 API 监控视为首要任务的团队在解决性能问题方面的表现远远优于不这样做的团队。

拥有正式 API 监控流程并视监控为首要任务的团队中,76%在最初的 24 小时内解决了 API 性能问题。

SmartBear 2019 年 API 现状调查

了解生产环境中的情况可以帮助比从客户那里得知 API 运行缓慢或未按预期执行更快地修复问题,这不足为奇。令人惊讶的是,仍有许多团队没有建立监控流程。SmartBear 开始研究如何让重视 API 质量的团队更轻松地实施此流程,并发现为了促进 API 监控的采用,它必须无缝地融入团队现有的流程中。

什么是 API 监控?

API 监控涉及利用监控工具(通常是合成监控工具)向您的 API 导入流量,并记录 API 在此给定流量下的行为。此过程使您的团队(DevOps、运维、质量保证和性能团队)能够深入了解生产环境中的情况。它在查明任何速度缓慢、功能不正确和停机的根本原因方面非常有帮助。一个好的合成监控工具能够通知您任何性能偏差,管理 SLA,并在出现问题时提醒您的团队。

如何在改变发布流程的情况下监控我的 API?

将 API 监控集成到发布周期中而不中断当前流程的第一步是尝试确定可以在何处重用资产以及如何自动化 API 监控过程。如果您的团队使用 Swagger、OpenAPI 规范或 SwaggerHub,您就已经离开始监控 API 更近了一步。AlertSite 是来自 SwaggerHub 团队的合成监控工具,可以使用您的 OpenAPI 规范文件自动创建监控。此外,在其最新版本中,您现在可以使用 Swagger Inspector 扩展开始监控您的私有 API。

开始监控私有(或内部)API 和公共 API 实际上非常简单。如果您熟悉 Swagger Inspector,那会更容易。

在这种情况下,我们使用 AlertSite(SmartBear 的合成监控工具)有以下几个原因:

  1. AlertSite 可以使用您的 OAS 文件或仅仅通过粘贴一个端点 URL 自动创建一个新的监控。
  2. AlertSite 监控 API 事务(验证每个 API 调用并确保整个流程按预期执行)。
  3. AlertSite 可以监控 SLA
  4. 您可以使用 AlertSite API 以编程方式驱动您的监控流程
  5. AlertSite 警报高度可配置、快速且准确——因此在需要时,正确的团队会收到警报。

使用 Swagger Inspector 扩展监控私有 API

Swagger Inspector 扩展可以从您的浏览器直接连接到此端点。点击“使用 Swagger Inspector”复选框以启用 Swagger Inspector 扩展并重新验证端点。

使用 OpenAPI 规范文件监控公共 API

要开始监控您的公共 API,您只需要 OAS 文件或一个端点 URL 即可开始。

要开始使用,请尝试使用 AlertSite 监控您的 API。我们提供30 天免费全功能试用,以便您了解它如何适用于您的团队。

© . All rights reserved.