oanylund / swagger-editor-server

swagger editor server that serves local file to the editor and update the file on every change

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README

Install

npm install oanylund/swagger-editor-server --save

#swagger-editor-server swagger editor server that serves local file to the editor and update the file on every change

Example

    var editor = require("swagger-editor-server")

##editor.edit(swaggerFile, [swaggerPort]) gives path for you to insert in browser to live edit of the swagger api file

Params

  • swaggerFile string - the path to the swagger api file
  • [swaggerPort=3000] number - the port the server will listen on

Example

    editor.edit(swaggerFile, 3000)

Output

Swagger editor started.
Open browser, paste this URL and start working: http://192.168.0.109:3000/#/edit

About

swagger editor server that serves local file to the editor and update the file on every change


Languages

Language:JavaScript 100.0%