- About
- Upload
- Header
- Servers
- Security
- Tags
- Main
- Schemas
- Wizards
- Export JSON
- Export YAML

# 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 tool a built-in tool.
Load Definition
Demo
Remove Paths
Remove All
Title
Version
Description
Contact Name
Contact Email
Contact URL
Terms of Service URL
License Name
License URL
External Docs
Documentation URL

OpenAPI Specification Servers Object

There are no servers defined. This means the API paths will be relative to the host and path the OpenAPI definition was loaded from.

URL
Description
Add Variable
Name
Description
Default
Enum
Add Enum Value
Value
Add Tag
Name
Description
External Docs
Docs URL
Add Security Scheme
Name
Type
Apply to all paths
Scheme
Bearer Format
OpenIdConnect URL
Parameter Name
Location
Flows:
Implicit
Password
clientCredentials
authorizationCode
Flow: {{ flowName }}
Authorization URL
Token URL
Refresh URL

OpenAPI Specification Scopes Object

There are no scopes defined yet for this oAuth2 flow.

Scope Name
Description

OpenAPI Specification Paths Object

There are no paths defined yet for this definition.

# 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)

Schema Name
Update
Generate
Download!
Generate
Download!
Schema
Methods
Generate

OpenAPI Specification Schemas Object

There are no shared schemas defined yet in this document.

Schema: