Swagger Editor Documentation
The Swagger Editor is an open source editor to design, define and document RESTful APIs in the Swagger Specification. The source code for the Swagger Editor can be found in GitHub.
Using the Editor on the Web
The Editor works in any web browser, and can be hosted locally or accessed from the web.
Take Me To The Web Version
Using the Editor on a local machine
You can run and use the Swagger Editor on your machine as well.
The following dependencies would need to be installed on your machine before downloading and running the Swagger Editor.
Once NodeJS is installed successfully, please install all the npm dependencies using
Setup with http-server module from GitHub
The Swagger Editor can be found in this public repository on GitHub.
Please run the following to run the Editor using the http-server module from GitHub. After downloading the latest version from Github, you will need to run these scripts on your terminal.
npm install -g http-server
Setup from Docker
The Swagger Editor can be found in this public repository on Docker.
Please run the following to run the Editor in your local machine from Docker.
docker pull swaggerapi/swagger-editor
docker run -p 80:8080 swaggerapi/swagger-editor
The Swagger Editor is an open source project under the Apache license. You can contribute to the project with suggestions, ideas, bug reports and pull requests in the Swagger Editor GitHub repository.
Please run the following to to see the Editor’s source code and work on the project from your local machine.
git clone https://github.com/swagger-api/swagger-editor.git
npm run build
npm start does not work, delete the node_modules folder, then run
npm install and
- If there is a problem with dist folder after cloning, go to the root and run
npm run build