thedgmbh / swagger-bundle

This is a bundle for Swagger UI and Swagger Editor embdedd with backend option to allow you smooth editing and viewing expreince.

Swagger Bundle

This is a bundle for Swagger UI and Swagger Editor embdedd with backend option to allow you smooth editing and viewing expreince.

You can show all the versions of the specs file and revert the commits.

Steps

1. Clone the repo.
2. Run this commands to get it to run

$ npm install
$ sh build.sh
$ npm start

Or you can use build docker image and run with docker

Share a local directory to save the yaml file

$ docker build -t swagger .
$ docker run -it -p 80:8080 -v ~/files:/app/files -d --name swagger swagger

Or you can use image from docker hub

$ docker pull theddot/swagger-bundle
$ docker run -it -p 80:8080 -v ~/files:/app/files -d --name swagger theddot/swagger-bundle

Browse

Swagger UI

go to [localhost or server ip]/

Swagger Editor

go to [localhost or server ip]/editor

Specs file versioning

You can revert a commit if anything happened go to [localhost or server ip]/versions

License

Licensed under MIT

Author

The D. GmbH - M. Mahrous

Feel free to contact us M. Mahrous and improve the code.