swagger-node-vagrant

A portable Vagrant environment for running swagger-node to quickly create APIs.

Developer Workflow

Spinning up a local environment

# 1. Install Vagrant (you can grab the installation for your OS at https://www.vagrantup.com/)

# 2. Clone this repository locally (or alternatively, just download the Vagrantfile)
git clone https://github.com/echelon-solutions/swagger-node-vagrant.git

# 3. Change into the repository directory and start vagrant
cd swagger-node-vagrant
vagrant up

# 4. That's it! You now have a node.js development environment for building Swagger APIs!

# 5. Now, you can easily SSH into the environment
vagrant ssh

Using the environment

# Create the Swagger API project (do this when creating a new API)
swagger-create my-new-api-project

# Edit the project in the Swagger Editor
swagger-edit my-new-api-project  # then point your browser to localhost:8080/#/edit

# Serve the API over http
swagger-serve my-new-api-project

Stopping the environment

• Stop your environment with vagrant halt
• Destroy your environment with vagrant destroy

Support

Please contact [email protected] with questions or suggestions.

You may also make changes yourself and open a pull request to have your changes merged.