Arazzo

Arazzo is a parser for OpenAPI Arazzo specification documents which describe API workflows (specific sequence of calls to achieve a particular goal in the context of an API definition). This library supports both JSON and YAML formats and can be used in both CommonJS (CJS) and ECMAScript Module (ESM) environments.

Features

• Parse OpenAPI workflow files from URLs, file paths, or raw content strings.
• Supports both JSON and YAML formats.
• Validates the parsed OpenAPI workflow.
• Binds operations and workflows.

Installation

You can install the package using npm:

npm install arazzo

Usage

import { OpenAPIWorkflowParser } from 'arazzo';

const parser = new OpenAPIWorkflowParser();

const workflow = await parser.parse('https://example.com/workflow.yaml');