什么是 API 生命周期管理?

  2017 年 3 月 29 日

应用程序编程接口(API)已成为业务增长和技术敏捷性的重要工具。API 使两种不同的服务能够相互交互和补充,为大量的工程和业务可能性打开了大门。因此,开发强大而具体的 API 来推动 API 经济是许多组织的重要考虑因素。 但是,开发一个 API 程序本身并非易事。将 API 从概念到弃用涵盖了整个 API 生命周期,这已成为构建具体 API 解决方案的关键工程问题。为了在当今竞争激烈、互联互通的商业环境中取得成功,组织必须给予其 API 程序一流的待遇,使开发人员能够灵活地与其不断发展的内部和外部环境集成。这是选择正确的 API 生命周期管理工具变得重要的一个重要原因。 API 领域的两项重大近期收购 Google 收购 ApigeeRed Hat 收购 3scale — 进一步证明该行业正在朝着 API 生命周期管理的需求靠拢。      考虑到超连接 API 经济的需求,SwaggerHub 迎合了 API 生命周期的各个方面,为您的 API 程序提供集中但灵活的解决方案。 让我们更好地了解生命周期的各个阶段,以及 SwaggerHub 如何适应。

了解 API 生命周期

API 生命周期的五个阶段是

  1. 规划和设计 API
  2. 开发 API
  3. 测试 API
  4. 部署 API
  5. 停用 API

规划和设计 API

API 规划和设计包括在 API 完全实施之前规划各种资源和操作以及业务案例场景。由于许多依赖于 API 的数字策略,实施它们需要可靠的设计。在上一篇文章中,我更详细地探讨了良好 API 设计的重要性。 因此,API 设计是一个重要的考虑因素,其中像 Swagger 这样的框架有很大帮助。SwaggerHub 提供了一个强大而完整的编辑器体验,用于设计 API 解决方案,并提供完整的 Swagger 支持,从而实现出色而高效的设计体验。这包括智能设计自动完成、内置模拟和 API 设计的实时可视化渲染,所有这些都构成了一个完整的设计体验。 

开发 API

API 的开发阶段侧重于根据计划和设计实施 API。尽快实施和构建 API 是许多组织关注的关键上市策略。与 API 设计同步实施所需 API 的便捷性和速度对于公司的 API 良好的市场策略至关重要。 这是开发开源 Swagger Codegen 的推动力,它通过从 API 的合同生成服务器存根和客户端 SDK 来简化您的构建过程,因此您的团队可以更好地专注于 API 的实施和采用。像 SwaggerHub 这样的平台可以更进一步,能够将 API 的设计和代码推送生成到组织的内部源代码控制环境,如 GitHub、Bitbucket 和 GitLab。 

测试 API

API 应该像对待任何应用程序一样获得一流的待遇。这意味着应彻底测试和监控 API 的性能问题。一旦您向其他开发人员提供您的 API,您就有责任确保没有任何东西影响 API 的质量和性能。 API 功能测试工具,如SoapUI和负载测试工具,如LoadUI,对于测试预生产环境中 API 的功能和性能至关重要。

部署 API

最终,API 必须满足最终用户的用例,无论是您自己的内部开发团队、合作伙伴公司还是公众。将 API 部署到安全的环境中,以便于发现和使用,对于您的 API 策略的成功至关重要。可以将完成的 API 推送到 SwaggerHub 注册表,以允许用户快速发现 API 的文档并与之集成。请务必记住,为了交付有保证的高质量 API 性能,在生产环境中监控 API 也至关重要。SwaggerHub 还允许组织和团队安全地将 其 API 部署到 API 管理平台,如 AWS API Gateway、IBM API Connect 或 Microsoft Azure,这重申了允许组织将现有工具集和环境绑定到其 API 工作流的原则。

停用 API

弃用是 API 生命周期中自然的一部分。它指的是停止支持 API 的版本,或者在许多情况下,停止支持整个 API 的阶段。例如,著名的 Netflix APIESPN API,以及最近的 Google Hangouts API的弃用,这些都是需要谨慎处理 API 弃用的重要原因。您可以在此处找到关于处理 API 弃用的良好建议SwaggerHub 的内部发布机制允许组织指示已弃用且不供使用的 API,因此最终用户可以清楚地知道哪个 API 是稳定的,哪个是不稳定的。在 SwaggerHub 中为各种事件添加 Webhook 的能力意味着您的组织始终可以触发外部服务来通知最终用户某个 API 已被弃用。无论您采用何种构建 API 的方法,我们都建议您使用一个值得信赖且对用户友好的工具来协调您的 API 生命周期,这可能是数字经济中的一个关键改变者。了解如何使用 SwaggerHub 集中管理您的 API 生命周期工作流程。