The Arazzo Specification Explained
An OpenAPI Description tells us what each operation of an API does, but it says little about how to use those operations together to achieve something useful. The Arazzo Specification addresses this by describing sequences of API calls, the data that flows between them, and what should happen as each call succeeds or fails. Arazzo also provides support for other API description languages such as AsyncAPI.
This section provides an introduction for readers not yet familiar with Arazzo and is organized by topic. It explains version 1.1.0 of the specification and assumes you have some familiarity with the OpenAPI Specification.
The following pages introduce the structure of an Arazzo Description and its main building blocks.
- Structure of an Arazzo Description:
arazzo,$self, andinfo. - Referencing API Descriptions:
sourceDescriptions. - Defining Workflows:
workflowId,inputs, andoutputs. - Describing Steps:
stepId,operationId, andoperationPath. - Using Runtime Expressions: expression syntax and
outputs. - Selecting Data: the Selector and Expression Type objects.
- Providing Parameters and Payloads:
parametersandrequestBody. - Defining Success:
successCriteriaand the Criterion object. - Controlling Workflow Flow:
onSuccess,onFailure,successActions, andfailureActions. - Composing Workflows: step
workflowIdanddependsOn. - Reusing Descriptions:
componentsand the Reusable object. - Coordinating Asynchronous Steps:
channelPath,action,correlationId, andtimeout.