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 这样的工具可以让团队使用不同的规范(Swagger、OpenAPI、AsyncAPI)与不同的利益相关者协作进行 API 设计。
协作的成果可以使其他团队开始开发 API、测试 API 并最终部署 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