Docs

Guides that walk through working with Arazzo documents in JavaScript and TypeScript, and the reference README for every package in the toolkit.

Guides

Longer reads on one problem each: what it is, how you would solve it by hand, and how the toolkit approaches it. Kept up to date as the packages change.

Updated

Parsing Arazzo Documents

An Arazzo document is several languages in one file, and one file in a network of documents. Why reading one properly is harder than loading YAML, what a tool needs from a parser, and how UseArazzo's parser approaches it.

Read guide

Package reference

Each package documents its own API in its README, which is the reference until the packages publish. All of them live in the arazzo-toolkit monorepo.

@usearazzo/parser

Parses Arazzo and OpenAPI documents into an ApiDOM data model, and parses runtime expressions and criterion conditions into syntax trees.

README on GitHub

@usearazzo/resolver

Dereferences $ref, JSON Schema, and reusable components across Arazzo and OpenAPI documents.

README on GitHub

@usearazzo/validator

Semantic validation and linting with LSP-compatible diagnostics. The Validator page introduces it.

README on GitHub

@usearazzo/runner

Executes Arazzo workflows against live APIs, step by step. The Runner page introduces it.

README on GitHub