今天,我们很高兴地宣布发布 Arazzo,这是一个新的 OpenAPI 计划规范,旨在描述 API 调用序列,以满足 API 提供者和消费者对编排的需求。
在数字经济日益以 API 为驱动的时代,需要准确地反映进行业务所需集成日益增长的复杂性。为了执行业务流程和功能,跨多个服务提供者调用多个 API 的组织需要指导和支持,以正确地实现 API 调用序列,并认识到每个步骤的成功和失败。
作为 OpenAPI 计划规范体系的一部分,工作流特别兴趣小组 (SIG) 创建了 Arazzo 规范的第一个版本,以满足日益复杂的集成需求。Arazzo 将允许 API 和集成服务提供者在 OpenAPI 规范的基础上进行构建,提供有关构成流程或功能的 API 调用序列的信息。
使用 Arazzo,API 提供者可以
- 将通过 OpenAPI 或其他 Arazzo 描述描述的多个操作链接到一个活动序列中。
- 提供基于 API 消费者调用的 API 返回的响应描述成功或失败的标准。
- 实现变量,这些变量可以将动态变量从一个 API 调用传递到另一个 API 调用,确保在描述的序列的上下文中,根据需要成功传递数据。
与 OpenAPI 规范一样,目标是创建一种丰富的描述语言,既可以用于文档,也可以从机器可读源自动创建集成代码。
SmartBear 首席 API 传教士兼工作流 SIG 团队成员 Frank Kilcommins 将 Arazzo 描述为
“迈向整个行业 API 成熟度提高的重要里程碑。通过提供基于价值的 API 使用确定性配方,Arazzo 规范通过其人类可读和机器可读属性充当活的 API 文档,减少了对带外入职指南的依赖。它确保了 API 生命周期中 API 提供者和监管利益相关者的可断言质量,同时还使工具供应商能够构建下一波 SDK 和代码生成器。
Arazzo 规范使人类 API 消费者能够更好地了解如何使用和组合 API,专注于他们要完成的工作,从而减少他们的集成平均时间。同时,它为新一波 AI 消费者提供了一种一致且可互操作的机制,以第一次并每次都能实现预期的 API 结果。”
随着越来越多的组织和工具制造商实施该规范,Arazzo 将不断发展。请访问规范 页面 和 存储库,或加入我们的 Slack 频道 以获取更多信息。