Swagger Editor
JavaScript HTML CSS Shell
Latest commit 92f3f25 Jan 2, 2017 @saharj saharj committed on GitHub Merge pull request #1144 from ponelat/fix/extra-formdata-params
Allow multipart/formdata to include non-file parameters
Failed to load latest commit information.
.github Update GitHub issue template Jul 14, 2016
config Make generator.swagger.io links protocol agnostic Sep 22, 2016
docs Fix CORS docs Sep 12, 2016
images WIP moving to webpack Mar 22, 2016
scripts fix lint issues on file Jan 2, 2017
spec-files Fix the problem in Twitter API spec Dec 29, 2016
styles Fix overflow error message inside modal on Firefox Jul 7, 2016
templates v2.10.4 Oct 9, 2016
test Change the URL in protractor Dec 29, 2016
views Add Firefox and IE prefixes to the style Apr 29, 2016
.dockerignore Remove Bower references and some clean up Mar 22, 2016
.editorconfig Initial commit - text editor all the way May 2, 2014
.eslintignore Fix lint errors Apr 6, 2016
.eslintrc.js Enforce single quotes in eslint Jun 24, 2016
.gitattributes Initial commit - text editor all the way May 2, 2014
.gitignore Remove Bower references and some clean up Mar 22, 2016
.travis.yml removed && Jun 5, 2016
404.html WIP moving to webpack Mar 22, 2016
CNAME WIP moving to webpack Mar 22, 2016
Dockerfile ADD everything to Docker image Apr 6, 2016
LICENSE Removing notice on L1 Dec 16, 2014
README.md v2.10.4 Oct 9, 2016
gh-pages.sh Make deploy to gh-pages a shell script Aug 13, 2016
index.html Depend on brace for Ace Editor Mar 22, 2016
index.js Use only absolute paths May 17, 2016
package.json Undo some dependency updates Dec 29, 2016
robots.txt WIP moving to webpack Mar 22, 2016
server.js Update server.js Aug 12, 2016
webpack.config.js lint fix Jul 15, 2016


Swagger Editor

Build Status Code Climate Dependency Status devDependency Status

Swagger Editor lets you edit Swagger 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).


Screenshot of the Swagger Editor

Running with Docker

The swagger-editor is published in a public repository on Dockerhub

You can run editor easily with docker:

docker pull swaggerapi/swagger-editor
docker run -p 80:8080 swaggerapi/swagger-editor

Running Locally

Download the latest release (v2.10.4) and serve the static files via your HTTP server. If you don't have an HTTP server, you can use http-server Node.js module.

Using http-server module:
npm install -g http-server
wget https://github.com/swagger-api/swagger-editor/releases/download/v2.10.4/swagger-editor.zip
unzip swagger-editor.zip
http-server swagger-editor

Building From Source

Make sure you have Node.js installed.

git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install
npm start