Git Product home page Git Product logo

swagger-node-vagrant's Introduction

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.

swagger-node-vagrant's People

Contributors

khalidx avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.