跳至主要内容
所有帖子由

swaldron

用 Arazzo 满足会议编排需求

作者 公告, 博客

今天,我们很高兴宣布发布 Arazzo,这是一项新的 OpenAPI Initiative 规范,旨在描述 API 调用序列,以满足 API 提供者和消费者的编排需求。

在一个日益由 API 驱动的数字经济中,需要准确反映完成业务所需的日益复杂的集成。调用多个 API 来执行业务流程和功能的组织,有时会跨多个服务提供商,需要指导和支持以正确实现 API 调用序列,并认识到每个步骤的成功与失败。

作为 OpenAPI Initiative 规范范围的一部分,Workflows 特别兴趣小组 (SIG) 创建了 Arazzo 规范的第一个版本,以满足日益复杂的集成需求。Arazzo 将允许 API 和集成服务提供商在 OpenAPI 规范之上构建,提供有关构成流程或功能的 API 调用序列的信息。

使用 Arazzo,API 提供者可以

  • 将通过 OpenAPI 或其他 Arazzo 描述描述的多个操作链接到一个活动序列中。
  • 提供基于从 API 消费者调用的 API 收到的响应来描述成功或失败的标准。
  • 实现可以将动态变量从一个 API 调用传递到另一个 API 调用的变量,确保根据需要成功地将数据通过描述的序列的上下文传递。

与 OpenAPI 规范一样,目标是创建一个丰富的描述语言,既可以用于文档,也可以用于从机器可读源自动创建集成代码。

SmartBear 的首席 API 布道者 Frank Kilcommins 也是 Workflow SIG 团队的成员,他将 Arazzo 描述为

“在整个行业中提高 API 成熟度的道路上的一个重要里程碑。通过为基于价值的 API 使用提供确定性方法,Arazzo 规范通过其人类和机器可读属性充当实时 API 文档,减少了对带外入门指南的依赖。它确保了 API 提供者和 API 生命周期中的监管利益相关者可以断言的质量,同时还授权工具供应商来构建下一波 SDK 和代码生成器。

Arazzo 规范使人类 API 消费者能够更好地了解如何使用和组合 API,专注于他们的工作,从而减少他们的平均集成时间。同时,它为新一波人工智能消费者提供了一种一致且可互操作的机制,让他们能够一次又一次地实现预期的 API 结果。”

随着越来越多的组织和工具制造商实施该规范,Arazzo 将不断发展。请访问规范 页面存储库,或加入我们的 Slack 频道 以获取更多信息。