The quickstart imported a single API. Here you will design a workflow: a sequence of API calls where each step can use the output of the one before it. Spirefy models workflows as a superset of Arazzo, the OpenAPI workflow specification, which Spirefy’s founder co-authored.
Bring in an API
Import an OpenAPI description on the Imports page, the same way as the quickstart. A workflow references real operations, so you want at least one API in the model first.
Start a workflow
On the Workflows page, create a workflow and give it a name, for example onboard-user. A workflow is a named sequence of steps stored in the same model as your APIs.
Add steps
Add a step and point it at an operation from your imported API. Then add a second step and reference an output of the first step as one of its inputs. This is how Arazzo chains calls: a value produced by one step, such as a new resource id, flows into the next.
Pass data between steps
Each step can declare outputs, and later steps can read them. The model keeps the references honest: if the operation a step points at changes, the workflow still points at the same operation in the model rather than a stale copy.
Run your own logic in a step
A step does not have to be an API call. It can run your own WebAssembly, so a custom transform or validation lives right inside the flow, beside the calls it supports.
Export it
When the workflow is ready, export it from the Exports page. The Arazzo exporter writes a standards-compliant bundle: the workflow file plus the API descriptions it references. Export plugins run in the app for one-off output and as a step in a workflow, so the same export drives a CI pipeline.
Where to go next
- Core concepts for the model behind all of this.
- Plugins to add importers and exporters, and build exporters and tools of your own.