What is OpenAPI-GUI?

OpenAPI-GUI is a GUI for creating and updating OpenAPI 3.0.x definitions.

How does OpenAPI-GUI work?

Upload an existing definition, or create a new one (select the red 'trash-can' button on the Upload tab to remove all Paths) and start adding Paths, Operations, and Parameters. When an existing definition is used, it is parsed and forms for editing each Path, Operation and Parameter will be created.

By default when OpenAPI-GUI starts, it loads the OpenAPI Petstore sample.

Click an item from the menu on the left to begin editing. View the JSON/YAML output at any time by selecting the "Export" tabs. When finished, click "Download" or Copy" to copy the output to your clipboard. OpenAPI-GUI saves data only to your browser's local-storage. Data is saved before destructive edits (deletions) and when the "Save" button is pressed. "Undo" will return to the last-saved state. Make sure you save your JSON/YAML output when finished.

Converting from Swagger / OpenAPI 2.0

Swagger / OpenAPI 2.0 definitions are converted using this online toola built-in tool.

Wizards (Work-In-Progress)

These functions may be experimental, or have only a rudimentary UI

• Validate definition using OpenAPI-converter (online version of swagger2openapi)built-in validator
• Preview documentation using widdershins and shins
• Dump markdown using widdershins
• Create CRUD operations from definition
• Import schema
• Create server SDK - {{cgData.servers.length}} languages using OpenAPI-Generator
• Create client SDK - {{cgData.clients.length}} languages using OpenAPI-Generator
• Serve definition for external use
• OpenAPI WordCloud visualisation
• OpenAPI Tree visualisation
• Generate link definition from sample (TODO)