Skip to content

README.md

Latest commit

 

History

History
25 lines (19 loc) · 1.54 KB

README.md

File metadata and controls

25 lines (19 loc) · 1.54 KB
Raw

OpenAPI GUI Editor (JetBrains Plugin)

GUI Editor for OpenAPI specification (OAS) 3.x.

  • Visual editing for OpenAPI 3.0, 3.1, and 3.2
  • Easy navigation through complex documents
  • One-click example generation based on referenced schemas
  • Convenient editing of complex schemas
  • Guided editing that makes common OpenAPI mistakes harder

Update May 10, 2026: Now supports OpenAPI 3.2!

Why does the plugin exist?

While the OpenAPI (formerly Swagger) specification was initially designed to be human-editable, it has grown increasingly complex over time. Even with syntax highlighting and robust autocompletion tools, creating and maintaining OpenAPI documents remains challenging. The verbose format is easy to get lost in and requires familiarity with numerous technical details.

OpenAPI GUI Editor solves these problems by providing an intuitive visual interface that allows you to create and modify valid OpenAPI documents in seconds - no deep specification knowledge required.

Restrictions

  • The plugin supports OpenAPI 3.0, 3.1, and 3.2 documents.
  • If your openapi.yml references multiple files, the plugin will only work with the main one.

Issues

If you have any problems or ideas of improvements, please feel free to create a new issue on Github or contact me personally on Telegram (@antonokolelov).