介绍 Arazzo 规范

Arazzo 规范是 OpenAPI Initiative（Linux 基金会协作项目）内的一个社区驱动的开放规范。

Arazzo 规范定义了一种标准的、与编程语言无关的机制，用于表达调用序列并阐明它们之间的依赖关系，以便在处理 API 描述（例如 OpenAPI 描述）时实现特定结果或一组结果。

Arazzo 规范可以以确定性的、人类可读和机器可读的方式来表达这些工作流程，从而改善提供者和消费者在使用 API 时所获得的体验。类似于 OpenAPI 对 HTTP 接口描述所做的事情，Arazzo 规范使人们能够表达 API（或一组 API）提供的功能用例，从而消除人类和机器消费者在使用 API 时所产生的猜测。

机器可读 API 工作流程定义文档的用例包括但不限于

• 交互式 动态 工作流程文档
• 自动文档生成（例如开发者门户文档）
• 由功能用例驱动的代码和 SDK 生成
• 测试用例的自动化
• 自动监管合规性检查
• 基于 AI 的 LLM 对 API 的确定性调用

Arazzo 规范并不强制使用特定的开发流程，例如 设计优先 或 代码优先。它通过使用 OpenAPI 规范描述的 HTTP API 建立清晰的工作流程交互来促进这两种技术。

这个 GitHub 项目是 Arazzo 的起点，包括如何参与。您也可以在此访问最新的 Arazzo 规范。

Arazzo 是 OpenAPI 的第一个附加规范

现在有两个规范。最初的、广为人知的 OpenAPI 规范，以及现在一个独立但互补的规范 Arazzo。OAS 提供了对单个 API 的描述，并且有新的版本正在开发中。Arazzo 提供了对一组 API 及其关系的描述。正在开发更多的附加规范，其目标是为 API 行为提供更完整和通用的描述。这些描述可以被自动化和代码生成所利用，从而减少生成价值所需的人工和时间。未部署或未使用的 API 不会为任何人创造价值。