The three hosts
The editor is one page that runs in three places. The forms, the tree, the preview, the problems and Try it out are the same everywhere; what differs is what each host can reach on your machine, and what it already does itself.
Get it
| Host | How |
|---|---|
| Web | Open api-genie.dev/editor. Chrome and Edge open and save folders through the File System Access API; Firefox and Safari take dropped files and save them as downloads. |
| Desktop | Install it from the Downloads page: since 0.12.0, each cli-X.Y.Z release carries installers for macOS, Windows and Linux, at the CLI’s version. |
| VS Code | Install the API Genie extension, then Open with API Genie Editor on a YAML or JSON file. The extension is on the Marketplace from 1.0.0 on; before that, the ide-X.Y.Z releases carry it. |
About in the toolbar names the host you are in, with the editor’s version and the host’s own.
What each host adds
| Web | Desktop | VS Code | |
|---|---|---|---|
| Opens a spec | Open spec… or a drop | File › Open Spec…, Open Recent, the command line | VS Code opens the file |
| Saves | To the folder, or as a download | To disk; Save As… | VS Code saves its document |
| Undo | The editor’s, across the open files | The editor’s | VS Code’s, per document |
| Code | The editor’s code editor | The editor’s code editor | VS Code’s text editor, beside the form |
| Text diffs | In the Changes tab and the import panel | The same | VS Code’s diff editor |
| Git | No | The Git tab | VS Code’s Source Control |
| Mock server | No | apigenie-server, installed |
apigenie-server, installed |
| AsyncAPI Try it | No | Kafka, AMQP, MQTT, WebSocket | The same |
| MCP servers | Over HTTP | Over HTTP and from a command, since 0.13.0 | Over HTTP; from a command since 0.13.0 |
| Environments | From an allowed folder, or dropped files | The spec’s folder, since 0.13.0; .env files on Windows only |
The workspace, since 0.13.0, .env files included |
| CORS proxy | A setting | A setting | Not needed |
| Theme | System, light or dark | The same | VS Code’s |
| Menu bar | No | File, Edit, View, with their shortcuts | VS Code’s |
| Files changed on disk | Read again on focus, in Chrome and Edge | Also watched, since 0.13.0 | VS Code reloads them |
| Library folders | A path, then a folder dialog | A folder dialog | The apigenie.editor.libraryFolders setting |
What happens to a file with unsaved changes when the disk changes is in Review and save changes.
The web editor
The page runs in your browser and works on your files: nothing is installed, and nothing leaves your machine unless you send a request with Try it out or the MCP tab. In Chrome and Edge, Open spec… picks the spec and reaches the files it refers to; when one cannot be read, Allow access to their folder… asks for the folder, which also gives Try it out its environment files and the Save as mock response button. In Firefox and Safari, drop the spec with the files it refers to, and the editor saves each as a download. A page cannot start a program, so the Git tab, the mock server and the brokers of AsyncAPI are not there.
The desktop app
The same page in a window of its own, with the machine around it: the system git for the Git
tab, a Node.js runtime for the broker client, the installed apigenie-server for the mock server.
It adds a menu bar, recent specs, since 0.13.0 a folder watch that reads a changed file again
about 300 ms after it changes, and apigenie-editor <spec> on the command line.
VS Code
The same page in a custom editor. VS Code owns the text, so the undo history and saving are VS Code’s, Show as code becomes Show in the text editor, and the text diffs open in VS Code’s diff editor. The extension host sends the requests of Try it out, so CORS does not apply and no proxy is needed; OAuth 2.0 opens the system browser and returns to a local port. Its colours follow VS Code’s theme, and its settings live in VS Code’s Settings (Settings).
Next
The editor’s hosts in the reference lists every feature with what each host does. Edit an API in forms is the short version of this guide: one job, from opening a spec to saving it.