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.wordnik.com/?import=http://generator.wordnik.com/online/api/swagger.yaml
Make sure you have all dependencies
node --version
bower --version
grunt --versionIf you don't have any of the dependencies, install them from their websites:
git clone [email protected]: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!
If you are familiar with Docker, you can build a Docker image of the current code using the project's Dockerfile.
sudo docker build -t my-swagger-editor ~/github/swagger-editor
Where ~/github/swagger-editor is the path to the clone of this repo and my-swagger-editor is the tag for the image.
In order to run the built image as a Docker container, use the following:
sudo docker run -ti -p 80:9000 my-swagger-editor
Where 80 is the port in the host and you can change to your environment.
If you want to know more about the process to build the images, go to the Docker Node.js Sample tutorial.
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).