可见 API 得到重用,而非重新发明

  2023 年 4 月 4 日

SmartBear API 技术布道师 Frank Kilcommins 做客 Stack Overflow 播客,畅谈 API 生命周期以及 API 规范如何帮助开发人员理解您的 API。继续阅读以了解他在访问期间提及的更多内容。  

API 推动了各行各业的创新,并为所有人提供了访问新功能的能力。然而,这并不意味着您可以随意发布一个 API 并期望它能成功。可见性对于任何 API 的成功都至关重要——但您如何确保您的 API 可见呢?  

注重良好的 API 设计 

API 消费者希望从快速查找和发现 API 中受益,而 API 提供商需要为他们创建可供浏览和交互的组合。这些 API 的消费者可以是开发人员、产品经理,甚至是业务分析师。  

这个过程听起来很简单,但对所有这些角色来说都已被证明是一个挑战。API 提供商必须专注于 API 设计,确保其可用性和可访问性。获取 API 访问权限并探索其功能界面的入门体验也至关重要。一旦 API 消费者找到并与某个 API 交互,他们会立即想了解其价值和局限性。这个 API 是否易于使用?这个 API 是否满足他们的业务需求?自己构建是否更容易? 

如果 API 能够快速轻松地进行评估,API 消费者就会发现,集成预构建的 API 将加速他们的软件开发生命周期,节省时间和资源,并减少错误。  

提高可发现性 

在交付 API 时采用设计优先的方法,使开发人员能够使用现有规范并确保 API 的质量。  

为此,利用能理解现有通用规范的工具,例如 SmartBear 的 SwaggerHub,可以解锁一套标准化的样式指南,用于在设计过程中如何表示您的 API。从那时起,团队可以开始构建 API 目录,使其易于根据不同的属性和业务价值产品进行发现。  

这将确保它们将在整个组织中被使用。如果一个 API 未被使用,那么它就没有任何价值。如果它没有任何价值,那它就是无用的。   

理解 API 的重要性 

从整体上看 API 生命周期时,重要的是要理解组织内部构建特定 API 旨在解决什么问题的战略愿景。  

您将该问题带入构思阶段,将其转化为设计,并协作以获取关于 API 是否解决了原始业务需求的反馈。同样,使用像 SwaggerHub 这样的工具可以使团队与不同的利益相关者协作进行 API 设计,并使用不同的规范(Swagger、OpenAPI、AsyncAPI)。 

 协作工作的成果使得其他团队能够开始开发、测试并最终部署 API。  

API 探索 

一旦 API 部署完成,API 提供商希望用户找到其价值,而 API 消费者则希望发现有价值的 API。要理解 API 的价值,用户需要一个专注于无摩擦探索的工具。 

SmartBear 的新工具 SwaggerHub Explore 能够立即可视化 API 数据,以便在一处了解 API 提供的功能和限制,而无需先进行 API 集成投资。这款新的免费工具支持多协议 API,包括面向 Kafka 的事件驱动端点和 Restful API。 

要最有效地使用 API,您必须了解 API 的行为方式。SwaggerHub Explore 提供了一个易于使用的界面,将立即为您的 API 工具包带来价值。 

总结

API 的发现和探索是一个耗时的过程,但它非常值得付出努力。当您在组织中努力创建 API 经济时,您需要能够在其生命周期中查找、探索和管理 API。这将有助于确保它们成功,并能为等式两端的用户提供价值:渴望访问新服务的开发人员和需要来自其组织或行业部门数据馈送的运营商。  

收听本集节目,了解 Frank 的更多见解

https://stackoverflow.blog/2023/03/15/visible-apis-get-reused-not-reinvented/ 

立即试用 SwaggerHub Explore: 软件测试、监控和开发工具 - 免费试用 | SmartBear

© . All rights reserved.