gchicareli / swagger-editor

Swagger Editor

Swagger Editor

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!

YAML Syntax

YAML became a first-class citizen as part of the Swagger 2.0 working group process. Documenation for the YAML syntax will become part of the documentation of the Swagger 2.0 spec.

Tips

You can import an existing YAML spec by using the import query parameter. For example:

http://editor.swagger.wordnik.com/?import=http://generator.wordnik.com/online/api/swagger.yaml

Running Locally

Install required dependencies on your machine

Make sure you have all dependencies

ruby --version
node --version
compass --version
bower --version
grunt --version

If you don't have any of the dependencies, install them from their websites:

• NodeJS
• Ruby
• Compass
• Bower
• Grunt

Clone the repository and install packages

git clone [email protected]:wordnik/swagger-editor.git
cd swagger-editor
npm install
bower install
grunt serve

This will open a browser window running current development version.

Building and publishing

Building

To build the project just run:

$ grunt build

This will build a new version of the web app, ready for production in /dist folder

Pushing to gh-page

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!

Contributing

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).