Swagger Editor lets you edit API specifications in YAML inside your browser and to preview documentations in real time. Valid Swagger JSON descriptions can then be generated and used with the full Swagger tooling (code generation, documentation, etc).
To understand how it works, you should try the live demo!
Expect the syntax to evolve quickly! (Note: the initial simplified syntax can be found under app/spec-files/consolidated.yaml if not available at launch.)
The idea is to iterate quickly on top of the Swagger 1.2 description format. As part of the Swagger 2.0 working group, the syntax will be a first-class citizen of Swagger 2.0. Visit http://swagger.wordnik.com to learn more or to get involved.
Make sure you have all dependencies
ruby --version
node --version
compass --version
bower --version
grunt --versionIf you don't have any of the dependencies, install them from their websites:
git clone git@github.com:wordnik/swagger-editor.git
cd swagger-editor
npm install
bower install
grunt serveThis will open a browser window running current development version.
To build the project just run:
$ grunt build
This will build a new version of the web app, ready for production in /dist folder
To copy everything in /dist folder to gh-pages branch and push it to github, just run:
$ grunt ship
Please do not touch gh-pages branch manually!
File issues in GitHub's to report bugs or issue a pull request.
All contributions must grant copyright permission to this project, the source of which is declared to be under an Apache 2 license (see LICENSE).