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 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.
You can import an existing YAML spec by using the import query parameter. For example:
http://editor.swagger.swagger-api.com/?import=http://generator.wordnik.com/online/api/swagger.yaml
Make sure you have Node.js installed. If you don't have Node.js, install it from it's Node.js website.
This project was tested with Node.js version 0.10. Make sure you have at least this version.
node --versiongit clone [email protected]:swagger-api/swagger-editor.git
cd swagger-editornpm startnpm install -g bower grunt-cli
npm install
bower install
grunt serveThis will open a browser window running current development version.
For development it's preferred to have grunt installed globally on your machine.
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!
See ./docs/config.rst and ./app/scripts/enums/defaults.js
If you are familiar with Docker, a Dockerfile is
provided.
Build an image named swagger-editor
sudo docker build -t swagger-editor .
Run the container, using the local port 8080 (you may change this to any available port).
sudo docker run -ti -p 8080:9000 swagger-editor
And open http://localhost:8080 in your browser
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).