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

Swagger Editor Local
Dia Diagram Editor Download For Mac
Swagger Editor Online
Swagger Editor Windows

While editing a.yml file in Sublime Text 2, go to the Sublime Text 2 menu. Go to Preferences -> Settings - More -> Syntax Specifc - User Sublime Text 2 will open a settings file specific to the language you chose to edit settings for. Swagger is a simple yet powerful representation of your RESTful API, and as part of the open tools initiative (joining November 2015) it is backed by members such as Microsoft, Google, PayPal and IBM.

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 in edit mode. For example:

Running Locally

Install Node.js

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.

Clone the repository and start it

Start on Mac and Linux

Start on Windows

This will open a browser window running current development version.

Development

For development it's preferred to have grunt installed globally on your machine.

Swagger Editor Local

Building

To build the project just run:

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:

Please do not touch gh-pages branch manually!

Configuration

See ./docs/config.rst and ./app/scripts/enums/defaults.js

Run with Docker

If you are familiar with Docker, a Dockerfile isprovided.

Build an image named swagger-editor

Run the container, using the local port 8080 (you may change this to any availableport).

And open http://localhost:8080 in your browser

Dia Diagram Editor Download For Mac

Contributing

Swagger Editor Online

File issues in GitHub's to report bugs or issue a pull request.

Swagger Editor Windows

All contributions must grant copyright permission to this project, the source of which is declared to be under an Apache 2 license (see LICENSE).

Swagger Editor Download For Mac