Editor

Edit APIs with forms, keep your files

A visual editor for OpenAPI and AsyncAPI that never rewrites what you didn't change. In the browser, on the desktop and in VS Code.

Open the web editorNo sign-up. Your files stay on your computer.

Your file, byte for byte

Every form edit changes only the lines it has to. Comments, key order, anchors and quoting stay as you wrote them, and opening and saving a file without an edit gives back identical bytes.

Many files, one API

References are followed across every file of the folder. Renaming or moving a schema, extracting a component or inlining it updates every file that refers to it.

Plain files, no server

The editor works on a folder on your computer. There is no account, no database and no project file: nothing leaves your machine unless you send a request with Try it out.

What it does

  • Forms for OpenAPI and AsyncAPIOperations, parameters, request bodies, responses, examples, servers and security for OpenAPI 3.0 and 3.1; servers, channels, operations, messages and Kafka, AMQP, MQTT and WebSocket bindings for AsyncAPI 3.0. Anything a form doesn't model is shown as raw YAML, never dropped.
  • Visual schema editorBuild JSON Schemas as a tree, with examples generated from them and checked against them.
  • Message flow diagramSee which applications send and receive which messages over which channels, and edit the flow in the diagram.
  • Diagnostics as you typeThe API Genie linter rules and your own Spectral rulesets, with one-click fixes for the rules that have a safe one. Each problem takes you to its form field and its line.
  • Live documentation previewThe documentation updates as you edit, rendered by the API Genie web components, with Try it out.
  • Import and compareImport Swagger 2.0, AsyncAPI 2.x and Postman collections. Compare with the last saved version, rated like apigenie diff, and export a bundled single file.

Where it runs

The web editor is available now; the desktop app and the VS Code extension ship with 1.0.0. What each host can and cannot do is in the editor's hosts reference.

  • In the browserOpen a folder and save in place in Chrome and Edge. Other browsers save your changes as downloads.
  • On the desktopThe same editor in its own window on macOS, Windows and Linux, with a Git panel, a mock server started from the toolbar, and Try it for AsyncAPI operations on Kafka, AMQP, MQTT and WebSocket brokers.
  • In VS CodeOpen any OpenAPI or AsyncAPI file with the API Genie Editor. VS Code keeps the undo history and the save, and the editor's problems show in the Problems panel.