OpenAPI Initiative

客座博文作者：BetterCloud 软件架构师 Donald Atha

当今 IT 团队面临的最大挑战之一是，过去 10 年 SaaS 应用程序爆炸式增长带来的繁琐重复性任务增加。公司正在使用越来越多的 SaaS 产品，这在管理员工入职和离职、管理许可和权限以及解决帮助台工单方面带来了挑战。在 BetterCloud，我们为 IT 团队提供工具，通过自动化和可配置工作流程来减少他们手头上的人工工作量。随着 SaaS 应用程序数量的增长，我们的客户依靠我们不断扩大的 SaaS 集成库。

测试 OpenAPI 生成器以实现快速集成

BetterCloud 内部的创新团队最近承担了开发原型解决方案的挑战，该解决方案可以让我们更快速地与各种 SaaS 应用程序集成，并将该解决方案扩展到数百个 API 提供商。该团队很早就达成一致，为了实现业务目标，我们需要将大部分流程自动化。该团队还达成一致，这是可行的，因为添加新集成的许多工作都是相同的，并且 OpenAPI 规范将允许我们通过使用现有的社区生成器来自动化这些部分。

为了充分理解问题，需要了解在 Bettercloud 添加集成以及我们产品的一些信息。BetterCloud 的工作流程引擎通过检测何时招聘新员工并随后授予其执行其角色所需的各种 SaaS 应用程序的访问权限，来自动化员工入职等流程。此入职场景只是我们支持的众多用例之一。所有这些用例都不可避免地需要从第三方提供商那里获取和存储数据，并更新提供商的状态。例如，在入职用例中，获取过程获取员工数据，检测状态更改，并触发入职工作流程。此工作流程调用提供商的 API 来为员工创建帐户或授予其对共享资源的访问权限，这种功能我们内部称为“操作”。

在开始添加新集成时，BetterCloud 首先验证提供商是否具有必要的 API 来支持我们的用例。此关键步骤为有效访问所需数据和评估提供商的 API 是否与我们的操作用例兼容奠定了基础。OpenAPI 规范提供了此信息的综合视图。

通过使用 OpenAPI 规范减少代码编写量

了解 API 后，下一阶段是实现获取逻辑。此阶段涉及调用提供商的 API 以在 BetterCloud 的基础设施中获取和存储所有必要数据。该团队探索了两种协调此过程的方法，这两种方法都利用了 OpenAPI 规范。两种方法的目标都是减少开发人员在添加新集成时必须编写的代码量。第一个方法涉及使用 OpenAPI Java 代码生成器 在 Java 中生成 HTTP 客户端，而另一种方法则使用扩展来标记规范，从而启用获取逻辑的配置。此标记规范输入通用引擎，该引擎根据扩展实现逻辑。这涵盖了从 API 获取数据，但获取后，必须将其存储以服务我们的应用程序。

BetterCloud 利用 SQL 数据库来存储我们获取的实体。为了创建模式，该团队使用 OpenAPI MySQL 生成器、Flyway 和 Terraform。这些工具有助于为新提供商创建和配置数据库。该团队能够稍微修改现有 MySQL 生成器的 mustache 模板，以便添加我们的内部字段，例如客户 ID。由于获取数据模型和 MySQL 数据模式都源自 OpenAPI 规范的实体，因此此过程的自动化变得很简单，因为数据模型是保持一致的。只需一个 OpenAPI 定义，我们就可以一键在所有环境中生成新数据库及其模式！

结论 - 更好地扩展 OpenAPI 规范，更好地价值

我们预计这种方法将使我们能够引导添加新集成的获取部分。通过自动化和代码生成常见元素，该团队可以专注于每个新集成的独特方面。就像我们在 BetterCloud 为 IT 团队自动化工作流程以使他们能够扩大工作影响力一样，OpenAPI 规范为我们提供了构建自己的自动化的工具，这些自动化扩展了我们能够为客户提供的价值。

我简直不敢相信我已经参加 GlueCon 十年了。这个活动一直是我“必须参加的会议清单”上的项目，因为它高度策划的内容，专注于即将改变网络的尖端技术。多年来，我有机会代表几家不同的公司参加 Gluecon，领导社区团队。然而，今年有所不同。不幸的是，我在 3 月份被裁员了，现在我正在寻找下一个令人兴奋的挑战。

像 Gluecon 这样的会议对我来说是建立人脉和与创新公司建立联系的绝佳场所。

早在 2013 年，当我第一次参加 Gluecon 时，会议上到处都是关于网络服务和 API 标准的讨论。作为 Context.io（一家电子邮件数据 API 公司）的开发者布道者，我发现 Gluecon 是与同行开发者和热衷于探索新 API 的人士会面的理想场所。

今年，主要的话题是 WebAssembly.

对于不熟悉 WebAssembly 的人来说，它是一种二进制指令格式，专门为网络设计。其目的是在 Web 浏览器中实现高性能代码执行。这些低级语言在 Web 上以接近本机的性能执行，彻底改变了应用程序的构建方式。

它让我想起了 Docker 第一次发布的时候，每个人都意识到容器的用途。事实上，Docker 的联合创始人 Solomon Hykes 曾在推特上著名地表示，如果 WASM 在 2008 年存在，Docker 就不会有存在的必要 (https://twitter.com/solomonstre/status/1111004913222324225)。

Solomon 公开展示 Docker 的第二次是在十年前的 Gluecon，与 Jeff Lindsey 一同展示。Jeff 在他在 Gluecon 上题为“未来架构：会话后端和 WebAssembly 组件”的演讲中提到了 Solomon 的引用。在他的演讲中，Jeff 精彩地阐释了标准 WASM 组件将如何导致创新型应用程序架构的出现。我很高兴能与 Jeff 叙旧，因为我们上次见面是在 2014 年的巴黎 dotScale 会议上。他当时正在展示 dotScale Dokku，它起源于……Jeff 去年在 Gluecon 上的 Docker 演示。

另一个非凡的环节是 The New Stack 的 Alex Williams 与 Fermyon 的创始人兼首席执行官 Matt Butcher 之间的炉边谈话。Alex 从 Programmable Web (RIP) 的时代起就开始报道最令人着迷的新兴技术，他与 Matt 的谈话也不例外。听到 Fermyon 如何在他们的 新云产品 中实施 WASM 的优势，例如跨语言兼容性和快速执行时间，非常令人兴奋。

并非 Gluecon 上的所有演讲都与 WebAssembly 有关。任何开发人员都会喜欢 Jason Harmon 的关于内部 API 最佳实践的演讲。将 API 视为产品而不是产品的特性，可以带来良好的开发者体验、更快的生产周期和更少的麻烦。Jason 目前是 Stoplight.io 的首席技术官，该公司在 2015 年通过了 Techstars Cloud 加速器。编辑注：Jason 也是 OpenAPI Initiative 早期的关键人物！

与 Samy Fodil 偶遇很有趣，我在 2016 年他的初创公司 Sage Hero 参加 Techstars Cloud 时认识了他。Samy 今年在 Gluecon 上谈论了他的当前创业公司 Taubyte，是的，WebAssembly！

Gluecon 总是以一些精彩的主旨演讲结束。不幸的是，为了为 Mile High Startups & Music 做准备，我不得不错过今年的演讲，这是一个我推广的每月技术活动，展示丹佛最好的当地音乐家。（向支持 Gluecon 和 Mile High Startups & Music 的 Elastic 大声致敬！）

我希望明年在那里见到你！

Open Geospatial Consortium (OGC) 最近宣布 OGC API - Tiles 已被采纳为正式的 OGC 标准。OGC 是一个专家组成的集体解决问题社区，来自 500 多家企业、政府机构、研究机构和大学，代表数十万地理空间专业人士，致力于使地理空间（位置）信息和服务成为 FAIR——可查找、可访问、可互操作和可重复使用。

OGC API - Tiles 标准定义了创建 Web API 的构建块，这些 API 支持以图块形式检索地理空间信息。支持不同形式的地理空间信息，例如矢量要素图块（“矢量图块”）、地图、影像和其他类型的地理空间信息。

新标准侧重于简单的可重复使用 REST API 构建块，可以使用 OpenAPI 规范进行描述。

谁使用 Open Geospatial Consortium，为什么？你能举个例子吗？

据GeoSeer.net报道，数百家组织使用开放地理空间联盟的标准发布了数百万个数据集。许多组织是 OGC 成员，他们积极参与共识流程，设计和发布标准规范，以提高互操作性。利用 OGC 标准的一些领域包括航空、建筑环境和 3D、商业智能、政府和空间数据基础设施、能源和公用事业等等。

这些标准被使用的最佳例子就是航空业，例如欧洲空中交通管理组织（欧洲空中管制机构）和美国联邦航空管理局（FAA）。这些团队使用 OGC 标准发布了许多数据，特别是地理标记语言（GML），他们在航空信息交换模型（AIXM）中实施了该语言。标准使用的另一个例子是 OGC API - 特征标准，该标准已被采用为实施符合欧盟 INSPIRE 指令的下载服务的最佳实践，这对整个欧洲大陆数亿欧盟公民产生了积极影响。

OGC API - 瓦片发布有什么新内容？它将如何使用？谁应该使用它？

我们对此非常兴奋。OGC API - 瓦片标准已经开发多年，现在终于面世了。OGC API 定义了用于创建 Web API 的构建块，这些 API 支持以瓦片形式检索地理空间信息，基本上是可以用附近瓦片一起流式传输的小图像芯片，以显示地图。它有很多优点，一些特殊功能包括地图瓦片和矢量瓦片。最终用户不必检索整个世界的庞大数据集，而只需检索单个瓦片。然后，他们可以使用该瓦片的标识符与同事进行协作。从事环境科学的人员可以从其他专业人员那里检索瓦片，反之亦然。现在，不必通过网络传输数 TB 的数据，只需传输一个子集。

我们已经为瓦片矩阵制定了标准模型，我们拥有一个注册表，各个组织可以在其中就使用的一组切片方案达成一致。我们已经看到了全面的效率和成本节省。通过网络传输完整数据集可能会产生一些费用，因此仅传输相关的子集可以节省成本。此外，性能也得到了提升。对于不发生变化的瓦片，现在可以提供缓存的瓦片。我们最近在布鲁塞尔举办了代码冲刺，来自世界各地的开发人员齐聚一堂，他们在很短的时间内就实现了该标准，并且只需通过各种客户端应用程序使用这些实现。

我要指出，所有这一切都得益于 OGC API - 瓦片标准使用了 OpenAPI 规范，这使得 Web 组件能够描述资源、模式等功能。在上一代 Web 服务标准中，开发人员需要解释标准的要求。现在，应用程序本身可以完成部分角色。应用程序可以解释 API 的预期用途。这减轻了开发人员的负担，让开发人员更加满意！

空间信息使用开源有什么优势？

OGC 制定的开放标准被开源和专有软件产品使用；他们这样做是为了使地理空间信息更容易查找、访问、互操作和重用。关于开放标准和开源软件的关键一点是它们降低了供应商锁定风险。在供应商锁定中，组织会与单个供应商绑定，必须从该供应商处获取产品。使用开放标准和开源软件可以有效地降低这种风险，组织不必从单个供应商处购买产品。此外，一些商业软件的常见部分来自开源软件，以降低开发一些可共享的基础技术的成本；例如，GDAL 开源库被多种商业软件产品使用。

您为什么要支持 OpenAPI 规范？主要优势是什么？

OpenAPI 规范使开发人员能够通过代码生成器自动创建源代码，只需解析符合 OpenAPI 规范的 API 定义文档即可。在过去，大多数源代码创建都需要开发人员手动读取和解释 API 定义文档，这会导致人为错误，并且肯定会延长接口实施时间。现在，应用程序完成了大部分解释工作，然后人类开发人员加入以编写业务逻辑。此外，使用 OpenAPI 意味着所有 API 都以一致的方式定义，以便所有开发人员都能以可预测的方式使用 API。

组织的效率提升令人难以置信。这是 OpenAPI 规范受到 OGC 社区青睐的关键原因之一。

OGC 开发开放标准，因此每个人都有机会对标准提供一些意见。其他组织不必担心是否会对访问标准进行限制。但是，组织也可以提出要求，作为社区，OGC 和 Linux 基金会（管理 OpenAPI Initiative 并负责 OpenAPI 规范）在让整个行业参与方面做得非常出色。在这些标准的设计中，包含了大量反馈，或者至少考虑了这些反馈。社区中的每个人都有机会为这些标准提供意见。

参与 OGC 的最佳方式是什么？

OGC 一年举办三次成员会议，地点遍布世界各地，有数百人参加。现在，随着旅行限制的放宽，这些会议现在是混合会议，支持远程参与者。

OGC 工作组利用这些会议来收集需求和规范。在这些会议之间，会有一系列工作组聚会。对于任何有兴趣参与的人来说，我建议访问 OGC 网站，查看有关会员资格的信息，其中也列出了工作组。我们有国防、航空、气象等领域的领域工作组。我们还有其他专注于规范的工作组，例如 OGC API - 瓦片和 OGC API - 特征。

下一个 OGC 会议将于 2023 年 2 月 20 日至 24 日举行，由欧洲航天局在意大利弗拉斯卡蒂主办。这将是 2023 年举行的三次会议中的第一次，另两次会议分别在 6 月在美国阿拉巴马州亨茨维尔和 9 月在新加坡举行。

我还想提到，OGC 运行着一些计划，我们运行着创新计划，会员可以加入。这些计划由 OGC 的协作解决方案和创新团队运营，由 OGC 会员提供资金，为研究和开发提供机会。我鼓励任何感兴趣的人访问 OGC 网站并参与这些活动。

---

OpenAPI 资源

要了解有关参与 OpenAPI 规范演变的更多信息：https://www.openapis.org.cn/participate/how-to-contribute

•  成为会员
• OpenAPI 规范 Twitter
• OpenAPI 规范 GitHub - 立即开始!
• 分享您的 OpenAPI Spec v3 实现

关于 OpenAPI Initiative

OpenAPI Initiative (OAI) 由一群有远见的行业专家创建，他们认识到标准化 API 描述方式的巨大价值。作为 Linux 基金会下属的一个开放治理结构，OAI 专注于创建、发展和推广一种与供应商无关的描述格式。OpenAPI 规范最初基于 Swagger 规范，由 SmartBear Software 捐赠。要参与 OpenAPI Initiative，请访问 https://www.openapis.org.cn

关于 Linux 基金会

Linux 基金会成立于 2000 年，拥有 1000 多个成员支持，是全球领先的开源软件、开放标准、开放数据和开放硬件协作中心。Linux 基金会的项目，如 Linux、Kubernetes、Node.js 等，被认为对世界上最重要的基础设施的开发至关重要。其开发方法利用了已建立的最佳实践，并满足了贡献者、用户和解决方案提供商的需求，以创建可持续的开放协作模式。有关更多信息，请访问 linuxfoundation.org。

OpenAPI Initiative 是一个由前瞻性行业专家组成的联盟，致力于发展和实施 OpenAPI 规范（OAS），现宣布 Bump.sh 已加入成为新成员。欢迎！

Bump.sh 是一个 API 合同管理平台，它可以帮助记录和跟踪 API：识别 API 结构中的变化，并让开发人员在整个组织中保持最新。Bump.sh 充当单一事实来源，提供始终保持最新状态的信息和变更日志。

该公司已获得 Galion.exe 和 Bpifrance 的 Digital Venture 基金领投的 400 万美元融资。

Bump.sh 首席执行官 Sébastien Charrier 表示：“我们相信模式是未来 API 开发的基石。作为供应商，我们有责任为最新规范做出贡献并保持最新状态。”“加入 OpenAPI 社区将帮助我们更好地为客户提供支持，并为 OpenAPI 规范发展的方向做出贡献。”

要详细了解 Bump.sh，请访问：https://bump.sh/

想要成为 OpenAPI Initiative 的成员？点击此处了解更多信息：https://www.openapis.org.cn/membership/join

OpenAPI 资源

要详细了解如何参与 OpenAPI 规范的演变，请访问：https://www.openapis.org.cn/participate/how-to-contribute

● 成为会员

● OpenAPI 规范 Twitter

● OpenAPI 规范 GitHub - 立即开始！

● 分享您的 OpenAPI Spec v3 实现

关于 OpenAPI Initiative

OpenAPI Initiative (OAI) 由一群前瞻性行业专家创建，他们认识到标准化 API 描述方式的巨大价值。作为 Linux 基金会下的开放治理结构，OAI 致力于创建、发展和推广供应商中立的描述格式。OpenAPI 规范最初基于 Swagger 规范，由 SmartBear Software 捐赠。要参与 OpenAPI Initiative，请访问 https://www.openapis.org.cn

关于 Linux 基金会

Linux 基金会成立于 2000 年，拥有 1000 多个成员支持，是全球领先的开源软件、开放标准、开放数据和开放硬件协作中心。Linux 基金会的项目，如 Linux、Kubernetes、Node.js 等，被认为对世界上最重要的基础设施的开发至关重要。其开发方法利用了已建立的最佳实践，并满足了贡献者、用户和解决方案提供商的需求，以创建可持续的开放协作模式。有关更多信息，请访问 linuxfoundation.org。