Design
designer
PlanPathspaths
Design is where a project version takes shape as a model. The workspace shows its classes and paths together in one domain-scoped canvas; the classic canvases — the Data Designer and the Paths editor — are the two surfaces it unifies; and Code and exports renders the result in every format the Suite generates.
| Page | What it covers |
|---|---|
| Studio home | Resume, recent versions, quick actions |
| Workspace | The unified surface: domains, lenses, the tree, the ⌘K palette, the inspector |
| Schemas | Classes, properties, types, tags, templates and imports |
| Paths | Paths, operations, parameters, request bodies, responses, security schemes and servers |
| Code and exports | OpenAPI, AsyncAPI, Arazzo, JSON Schema, GraphQL and SQL; the source editor and the review step |
| Comments | Threads on classes, properties and operations |
| Try it and mock | Send a request from the inspector; the hosted mock |
| Versions, branches and tags | Published versions are read-only; the git-like features and their flag |
| AI assistant | The Ollama-backed chat and the AI buttons |
| Workspace settings | Starting lens, inspector width, view simplification |
| Classic canvas | The Data Designer and Paths editor as standalone surfaces |
Projects and versions themselves are created, cut and published in the main app — see Build and Ship in the Apiome documentation.
Studio home
Resume the last version you opened, or start something new.
Workspace
Schemas and paths in one domain-scoped surface, with three lenses and an inspector.
Schemas
Classes, properties, types, tags, templates and imports.
Paths
Paths, operations, parameters, bodies, responses, security schemes and servers.
Code and exports
Generate the version in six formats, download it, and edit the OpenAPI source.
Comments
Threads on classes, properties and operations in the workspace, with mentions.
Try it and mock
Send a request from the inspector to a server or the hosted mock.
Versions, branches and tags
Published versions are read-only; the git-like features and the flag behind them.
AI assistant
The Ollama-backed Studio assistant and the AI buttons on the design surfaces.
Workspace settings
The starting lens, inspector width and view simplification, saved per user.
Classic canvas
The Data Designer and Paths editor as standalone surfaces, with their tools and dialogs.