Editor
Edit APIs with forms, keep your files
Edit OpenAPI and AsyncAPI in your browser without reformatting the rest of the file. Comments, key order and quoting stay intact.Web editor available now. Desktop and VS Code editions ship with their 1.0.0 releases.
- A diff of your edit, not a reformatForm edits preserve untouched content, including comments, key order, anchors and quoting. Open and save without editing, and the bytes are identical.
- References stay in syncFollow references across files in the open folder. Rename, move, extract or inline a component, and the editor updates references to it.
- Plain files, no serverWork on a local folder, without an account, database or project file. Nothing leaves your machine unless you send a request with Try it out.
The form, and the diff it leaves
Change the summary of createShipment in its form and save. Only that line changes; the surrounding YAML keeps its formatting. Download the same file and try the edit yourself.
Open the screenshot at full size$ git diff carpet-express.openapi-31.yaml
@@ -195,7 +195,7 @@
$ref: '#/components/responses/UnexpectedError'
post:
tags: [Shipments]
- summary: Create a shipment
+ summary: Book a shipment
description: |
Books a shipment with the selected carrier service. The request body isWhat 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
Start in the browser today. Desktop and VS Code editions ship with their 1.0.0 releases; the host comparison lists their capabilities and limitations.
- In the browserOpen a folder and save in place in Chrome and Edge. Other browsers save your changes as downloads.
- Desktop, from 1.0.0The 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.
- VS Code, from 1.0.0Open an 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.