OpenAPI-GUI can be run as a static web application by any web server, including GitHub pages. You can simply point a browser at the index.html page from your file-system and everything should work.
Alternatively, running the included openapi-gui micro-server will start the application,
on the port specified by the PORT environment variable, defaulting to 3000. This will also
give you a built-in API based on openapi-webconverter for fast local conversions and validations.
At present, OpenAPI-GUI implements a single storage engine using the browser's localStorage.
Protected by a same-origin policy, the current OpenAPI definition is stored as a JSON string in the following keys:
| OpenAPI version | Storage Key |
|---|---|
| OpenAPI 3.0.x | openapi3 |
| OpenAPI/Swagger 2.0 | swagger2 |