我们知道,设计完美的 API 并非易事。每个 API 都是精心制作的,并采取措施来确保质量和功能。诸如 OpenAPI (以前称为 Swagger) 之类的 API 定义格式为此过程提供了标准化 - 一个用于开发团队描述和确定每个 API 应如何运行的约定。但是,确保 API 质量并不会在设计 API 后结束。
您 API 的质量应超越部门障碍,这样您才能知道您的 API 始终在交付其设计的价值。通过监控您设计的 API,无论是监控预生产环境中的 API还是生产环境中的 API,您都可以完全了解该 API 的性能和行为。
监控您的 API 可以获得什么?
监控工具可以深入了解您的 API 的行为方式。了解您的设计如何实现、运作以及随着时间的推移表现,将有助于
最终,监控您的 API 可以帮助您改进。通过在最终用户之前发现问题,接收关于 API 的性能、可用性和正确性的反馈和可操作的数据,您可以不断创新并推动更高的采用率。
那么,究竟什么是合成监控工具?
合成监控是一种主动监控您的数字资产的方法。合成监控工具通过执行您的应用程序或 API 将执行的关键操作或事务来模拟真实用户。与监控真实用户交互不同,合成监控为组织提供了一种监控用户将遇到的内容的方法,以便可以在真实用户遇到问题之前捕获并修复任何问题或性能偏差。
API 监控通常分为两种类型 – API 端点监控和 API 事务监控。API 端点监控确保每个端点都正常运行,而 API 事务监控支持多步骤监控,捕获序列中每个步骤的数据。
这对 API 开发团队意味着什么?
越来越多的公司认识到设计是软件开发生命周期中必不可少的一部分的价值。但是,很少有公司能够在业务结构的其他要素中成功利用这些设计。
作为开发人员,确保您创建的工件(例如 OpenAPI 规范文件)在您的公司中得到正确使用至关重要。了解 API 生命周期中的后续步骤可以帮助改进您的设计流程以及后续流程。要实现真正的 DevOps 文化,协作和互操作性至关重要,而开发团队是支持 DevOps 计划的关键要素。
重用 OpenAPI 规范文件来监控您的 API
当您设置 API 监控时,根据您使用的工具,您必须指定要检查的端点或事务,有时这可能需要额外的资源来制作详细的脚本来重新测试 API。我们理解,对于支持 CICD 计划和敏捷流程的团队来说,这根本不是一个选择。
这就是为什么我们很高兴地宣布,我们在 AlertSite(SmartBear 的合成监控工具)的朋友已经引入了对重用 OpenAPI 规范文件以创建新 API 监控器的支持。这使得可以使用 Swagger 工具监控您设计的 API 的性能、可用性和功能正确性。 AlertSite 可以在几分钟内帮助您启动并运行,而无需额外的编码要求。
通过这种新的集成,您的开发团队可以简单地将任何现有的 OAS 定义(目前支持 OAS (或 Swagger) 2.0)移交给运营团队以自动生成监控器,以确保 API 按预期运行。或者,更好的是,开发团队可以利用 OAS 定义在预生产环境中创建新的监控器。
为什么这很重要?
当在 DevOps 环境中工作的组织可以重用现有资产时,它可以减少摩擦并消除部署过程中不必要的障碍。遵循“设计优先”的 OAS 方法需要详细规划每个 API 功能的期望和要求,因此,能够以减少部署时间以及平均解决时间的方式来实现这一点对于敏捷团队至关重要。
另一个主要好处是,利用 API 定义创建新监控器可以带来跨职能协作和一致性。随着 API 的发展和新版本的发布,开发和运营团队可以继续重用 OAS 定义来更新监控器,从而确保 API 继续按预期运行。
为了增强其 API 监控功能,AlertSite 的 OpenAPI 规范支持使开发人员和运营团队都可以轻松确定他们所依赖的 API 的状态和行为。AlertSite 使 DevOps 团队能够持续监控异常情况,并发送包含可操作的上下文数据的定向警报,以便可以快速解决任何问题,从而确保您的 API 不仅可用,而且还提供其设计中所设想的体验。 AlertSite API 监控功能的这种增强只是众多增强功能中的第一个,计划在 2018 年推出激动人心的新集成和功能。
感谢阅读!正在寻找更多 API 资源?订阅 Swagger 新闻简报。每月收到一封包含我们最佳 API 文章、培训、教程等的电子邮件。订阅