I don’t have answer now why this happens but I faced these few or the issues with different versions of Swagger and added here. but give few more hit after server start. Also use a different browser window every time you try with new option. if not, can you please try with all one by one. I hope you have tried all different options mentioned in the article. The other good option could be not to use -o option while starting http-server and wait for few seconds to run editor on browser.įeel to reach me if any issue, i will try my best to answer asap. In one of the machine, the default url was appended with extra slashes causing 404 error like Try for few more time or sometime http-server command without swagger works. If 8080 is in use in you machine, then force http-server to start at another port using -p xxxx option.įor first few time you can get blank page with 404 error. the first one i found that http-server runs on default 8080 port. > http-server swagger-editor -o (-o will open the Editor into default browser) It should be like – http-server\swagger-editor\…. Once http server installed, unzipped and copy the swagger-editor directory in http-server folder at – C:\Users\ urUserName\AppData\Roaming\npm\node_modules\http-server Run the following command to install http-server To run editor tocally http server is needed and you can use http-server Node.js module
NPM INSTALL SWAGGER EDITOR HOW TO
Swagger docs site has given how to run swagger editor locally but it bit confusing, it’s confusing to me, not sure about other’s but have seen lots of guys asking the same question how to install and run it.ĭownload latest version of Swagger-Editor from git-hub, current stable version is Swagger-Editor-v2.9.8 This is not mandatory but could be useful when creating project from command prompt using swagger commands. If any issue or error installing npm, reinstall node and then try to install npm again. Run following command to install npm dependency “C:\NODE_INSTALLED_DIR\nodejs”Īfter nodejs installation, open new nodejs command prompt and prefebly close the one opened. Once installed successfully, cross check the path variable updated with node installed location e.g. docker run -d -p 80:8080 swaggerapi/swagger-editor. Install node.js to your local machine as an admin. docker pull swaggerapi/swagger-editor docker run -d -p 80:8080 swaggerapi/swagger-editor. but there are some tricks I would like to key-down here which i struggle while installing and running Swagger locally, sorry Swagger-Editor 🙂 Make sure you have Node.js installed.Swagger Editor Installation is almost similar the way IBM API designer installation(local) describes in one other article. Using http-server module: npm install -g http-server If you don't have an HTTP server, you can use http-server Node.js module.
You can run editor easily with docker: docker pull swaggerapi/swagger-editorĭocker run -p 80:8080 swaggerapi/swagger-editorĭownload the latest release (v2.10.4) and serve the static files via your HTTP server. The swagger-editor is published in a public repository on Dockerhub
NPM INSTALL SWAGGER EDITOR FULL
Valid Swagger JSON descriptions can then be generated and used with the full Swagger tooling (code generation, documentation, etc). Swagger Editor lets you edit Swagger API specifications in YAML inside your browser and to preview documentations in real time.
0 kommentar(er)
