Features · Contract editors
OpenAPI Editor
The OpenAPI Editor opens OpenAPI 3 and Swagger files, YAML or JSON. It has two views:
- Overview (the default): a navigator on the left with the overview, the problems, the endpoints grouped by tag and
the components, and the selected item on the right, where you edit it.
Ctrl+Kfilters the navigator. The problems view lists what is wrong with the contract. - Structure: the whole document as a tree, for everything the overview does not cover, such as vendor extensions, webhooks, security schemes and examples. See Structure view.
A new, empty file can start from a skeleton with openapi: 3.0.3, an info block and empty paths.
Structure view
The Structure view of the OpenAPI, AsyncAPI and JSON Schema editors shows the document as a tree. Every key and value
can be edited: change a value or its type (string, number, boolean, null, object, array), rename a key, add a key or an
array item, delete a node. Values are written when you press Enter or leave the field, so a half-typed value never
ends up in the file.