OpenAPI designer

Design interface for creating OpenAPI (Swagger) specification files. Live demo

Setup

0. Have a Node.js install that's not way too old (v4+ should work for everything).
1. Install Aurelia CLI (npm install -g aurelia-cli)
2. Clone this repo (git clone https://github.com/apinf/open-api-designer.git)
3. Install dependencies (npm install)
4. Build the code (au build) and open index.html OR run the webserver integrated in Aurelia using au run and open the URL that is printed after building (usually http://localhost:9000)

Docker

0. Follow setup instructions step #2
1. Run docker build -t openapi-designer . (Run with --build-arg env=prod to compile the production version.)
2. Run docker run -p <port>:80 openapi-designer replacing <port> with the port you want the app to be accessible at.
3. The designer should now be accessible at http://localhost:<port>

Development Status

Resources

• OpenAPI Specification