OpenAPI 驱动的 API 开发的优势

  2018年3月15日

随着行业的成熟,标准必然会出现,以实现更好的工程和使用。

自古以来,情况一直如此。无论是罗马运河的几何复杂性,埃及金字塔的三角对称性,还是印度寺庙的空间和谐性,标准和规范都帮助工程师为可持续工程制定了独特的规则。

标准有助于提供一个通用的沟通和开发框架,并指导我们根据特定需求选择正确的工具。

在 RESTful API 世界中,API 定义的标准是 OpenAPI 规范 (OAS)

OAS 基于最初的“Swagger 规范”,在 API 开发中获得了巨大的关注,我们看到成千上万的 API 开发者和消费者正在采用它。

但为什么是现在?为什么全世界突然接受了 RESTful 架构的标准化规范,而就在几年前,REST 爱好者几乎完全反对使用规范来定义 REST?

REST API 的新时代

API 不再局限于应用程序的后端。早在 PC 出现之前,API 就已经存在,它们将不同的逻辑单元连接在一起。

过去,API 并非为大量用户设计。API 是数据驱动的,旨在解决连接和通信的少数特殊用例。文档很少,即使有也很简单,并且所使用的规范直接遵循核心数据库的术语,这意味着只有少数网络中的人才能理解它们。

毋庸置疑,过去的 API 并非旨在供自助使用。

上述情况不再适用于现代 Web API。我们正处于一个新时代,API 不仅允许企业更快地构建和扩展,而且通过集成和消费第三方服务来推动战略和业务目标,以实现共享收入和增长。新时代的 REST API,与它们的前身不同,不是数据驱动的,而是更多地由消费者驱动。

设计良好并能解决实际消费者问题的 API 是制胜关键,我们看到 DropboxStripeeBay 等公司的 API 都注重这一点。许多公司现在都要求基于 HTTP 标准的可重用接口,这些接口允许数据和功能的重用,并为消费者需求和自助服务而构建。

OpenAPI 规范 (OAS) 登场

OAS 之于 REST 就像 WSDL 之于 SOAP。它为设计师、开发者、测试人员和运维人员提供了一个通用的框架来构建和维护 API。可以将该规范视为构建和实现 REST API 的一套规则。OAS 是与语言无关的,并且既可供人类阅读,又可供机器阅读,这使得人类和计算机都能发现和理解服务的各项功能,而无需访问源代码、额外文档或检查网络流量。

那么,我们知道 OAS 可以帮助您构建以消费者为中心的 API,但是如何才能在您的开发生命周期中最好地使用该规范呢?

OpenAPI 驱动的 API 开发

定义驱动的 API 开发主张在实现任何其他生命周期操作之前,首先设计 API 的定义。这意味着,甚至在您开始构建 API 的业务逻辑、测试 API 是否存在任何错误或缺陷,或执行任何其他生命周期功能之前,您都将设计 API 的接口,详细说明您的 API 端点将展示的确切请求和响应。

OAS 驱动方法的优势

定义驱动的方法带来了许多直接与以消费者为中心的 API 开发方法相关的巨大优势。

  • 更好的开发者体验 (DX):DX 是开发者在使用和集成您的软件时可能经历的所有体验的总和,包括积极和消极的。在一个竞争激烈的 API 生态系统中,良好的 API 消费开发者体验至关重要。您可以提前关注 API 消费者的需求。这使您能够采用以开发者为中心的方法,并确保在与时间和其他开发方面竞争之前,以最佳方式满足最终消费者的需求。
  • 实现独立性:这种方法减少了在您的 API 上工作的不同团队之间的依赖关系,例如前端和后端团队,或者架构师、技术文档编写者和 QA。这是因为 API 的定义使各个利益相关者对 API 应该做什么以及它如何与他们的工作职能相关联保持一致。它充当了 API 预期服务与其功能之间的契约,并确保了它们之间更便捷的沟通。
  • 更快上市:由于消除了依赖关系,不同团队可以以更快、更高效的速度执行其职能。团队之间的交接过程大大简化,这使得您的 API 能够以更快的速度发布。

结语

现代 API 不再符合传统的以数据为中心的世界观。无论是软件还是硬件,应用程序都相互连接,API 处于这场数字革命的中心。为了让这些应用程序能够连接,我们需要真正的开发者理解您的 API 的作用,这就是为什么以消费者为中心的 API 观点正在迅速普及。

OpenAPI 规范通过定义驱动的方法,帮助您实现解决潜在客户需求的 API,同时确保良好的开发者体验。

您现在可以观看这个关于定义驱动的 API 开发方法的点播网络研讨会。在接下来的几个月里,我将继续发表更多文章,详细解释 OAS 定义如何帮助 API 生命周期的不同功能,如 API 设计、文档、测试和监控。

© . All rights reserved.