swagger-editor-local

Spawn a Swagger Editor locally that automatically syncs changes to a swagger.yaml file.

Environment

• Install Vagrant

Development Workflow

1. Clone the repository

git clone https://github.com/echelon-solutions/swagger-editor-local.git

2. Run the Swagger Editor

# Change into the repository directory
cd swagger-editor-local

# Bring up the Vagrant environment
vagrant up

# Login to the environment
vagrant ssh

# Change into the project directory
# Vagrant syncs the /project directory with your host machine
cd /project

# Install the dependencies
npm install

# Run the Swagger Editor
# The swagger-editor will be available at http://192.168.33.10:8080/swagger/editor
npm run editor

The swagger.yaml file is available at

• ./swagger-editor-local/swagger.yaml on the host machine
• /project/swagger.yaml when logged in to the Vagrant environment

Support

Please reach out to [email protected] with any questions, concerns, or suggestions.

Also, feel free to clone/fork this project and suggest changes and updates via a "Pull Request".