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