This takes you from a fresh install to your first imported API in a few minutes.
Launch Spirefy Studio
Open the app. It starts on the Studio shell, with the Imports, API Workshop, Workflows, and Exports pages ready. Each of those pages is a plugin, loaded at startup.
Import an API
- Go to the Imports page.
- Choose an OpenAPI, AsyncAPI, or Arazzo file. If you do not have one handy, the OpenAPI Petstore is a good first file.
- Spirefy detects the format and brings it into the unified model. Every entity it creates records where it came from, so you always know its source.
Look at the model
Open the API Workshop. The operations, schemas, parameters, and responses from your import are now part of one model. Browse the surface and open an operation to see its detail.
Run a check
Still in the API Workshop, run the Spectral engine over the model. It applies a Spectral ruleset the way the Spectral command line would, and reports what needs attention. The engine is a plugin, so you can swap in a different ruleset later, and where a finding is AI-fixable, the on-device model drafts the fix for you to approve.
Where to go next
- Your first workflow takes a spec further, into a multi-step workflow.
- Core concepts explains the unified model everything builds on.
- Plugins shows how to add formats and tools, and build exporters, pages, and tools of your own.