Require that APIs which chain multiple operations to accomplish real work provide Arazzo workflow definitions describing those sequences. I want the multi-step paths a consumer must follow, the order, the inputs, and the outputs handed off between calls, expressed as machine-readable workflows rather than left to prose and tribal knowledge. Arazzo turns an integration from a puzzle into a followable, testable recipe, and it makes those recipes discoverable and reusable across teams and agents. I hold provided workflows as a design-time expectation for any API whose value depends on orchestrating several operations.
Arazzo Workflows Provided
Rules
APIs.json Arazzo Info
APIs should declare Arazzo workflows so consumers and agents can discover documented, multi-step sequences for accomplishing common tasks with the API. Declaring a property of type Arazzo in the AP...
Strategies
APIs Provide Orchestration Workflows
I want our APIs to ship the workflows, not just the endpoints, because most real jobs take more than a single call and I would rather hand consumers a proven path than make them assemble one from s...
Experiences
Integration
Integrating digital resources and capabilities into other systems using HTTP APIs is commonplace in any enterprise. However, the experience, skills, time, and cost required for successful integrati...
Reusability
Reusability is the experience of finding and applying an existing API instead of building the same capability again. It depends on discovery, consistent design, and clear documentation that make an...
Lifecycle
design_services Design Design
Design is where the human experience of an API is won or lost. I work design-first, shaping the paths, schema, errors, and naming in the contract before development begins, so that consistency is b...
travel_explore Discovery Production
Discovery is how APIs get found and reused instead of rebuilt. APIs.json, catalogs, and search make the APIs I operate visible to the people who need them. Good discovery is what turns a pile of AP...