vajahath / open-swagger-ui Goto Github PK

View Code? Open in Web Editor NEW

16.0 2.0 1.0 1.44 MB

A handy CLI / API to open swagger doc in swagger ui.

Home Page: https://www.npmjs.com/package/open-swagger-ui

License: MIT License

JavaScript 23.90% TypeScript 76.10%

npm swagger swagger-ui cli swagger-cli javascript typescript

open-swagger-ui's Introduction

open-swagger-ui

An easy CLI to open swagger.json or .yaml files in Swagger UI.

$ open-swagger-ui ./swagger.json --open # done !

Install

Requires Node >=10.

From npm,

npm i -g open-swagger-ui

From Github Package Registry. (Guide).

Type definitions are bundled with this package.

CLI Usage

$ open-swagger-ui ./swagger.json
# => starts the server.

$ open-swagger-ui ./swagger.json --open # or -O for short
# => starts server, opens it in browser.

$ open-swagger-ui <absolute-path-to-swagger.json> --port 8899
# => you can put absolute/relative path for swagger.json
# => if the requested port is not available, a random port is chosen.

# Oh yes! You can put urls too..
$ open-swagger-ui https://petstore.swagger.io/v2/swagger.json

`--help` for help

$ open-swagger-ui --help
Usage: open-swagger-ui [options] <swagger-file>

An easy CLI tool to open swagger.json or .yaml files in Swagger UI.

Options:
  -V, --version      output the version number
  -O, --open         Open stuff in browser
  -P, --port <port>  Preferred port. If not available, a random port is selected
  -h, --help         output usage information

APIs

You can use this as a module too, just in case you want.

const { startServerWithSwaggerFile } = require('open-swagger-ui');
// or
import { startServerWithSwaggerFile } from 'open-swagger-ui';

startServerWithSwaggerFile('./path/to/swagger.json', port)
  .then(({ app, port, swagFilePath, server }) => {
    console.log(`app started on port ${port}`);
    // app is the express server underneath
    // you may freely add routes to it like
    // app.use(stuff);
  })
  .catch(err => console.error('something went wrong', err));

The startServerWithSwaggerFile function returns express app, the HTTP server instance, port in which the file is open and the reference swagFilePath.

Licence

MIT © Vajahath Ahmed

open-swagger-ui's People

Contributors

Stargazers

Watchers

Forkers

xuxiaoahang2018

open-swagger-ui's Issues

Add support for yaml files

Currently only JSON files are supported. Support yaml files as well.

I am getting the following error when running `--help`

internal/util.js:257
throw new ERR_INVALID_ARG_TYPE('original', 'Function', original);
^

TypeError [ERR_INVALID_ARG_TYPE]: The "original" argument must be of type Function. Received type undefined
at promisify (internal/util.js:257:11)
at Object. (/usr/local/lib/node_modules/open-swagger-ui/node_modules/compress-brotli/src/index.js:9:18)
at Module._compile (internal/modules/cjs/loader.js:707:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:718:10)
at Module.load (internal/modules/cjs/loader.js:605:32)
at tryModuleLoad (internal/modules/cjs/loader.js:544:12)
at Function.Module._load (internal/modules/cjs/loader.js:536:3)
at Module.require (internal/modules/cjs/loader.js:643:17)
at require (internal/modules/cjs/helpers.js:22:18)
at Object. (/usr/local/lib/node_modules/open-swagger-ui/node_modules/keyv/src/index.js:5:24)

C:\Users\XXXX\Desktop\Specification>open-swagger-ui .\test.json
× Loading file ..
Error: The given swagger file (C:/Users/jarajput/Desktop/Specification/test.json) could not be found.
    at C:\Users\jarajput\AppData\Roaming\npm\node_modules\open-swagger-ui\dist\app.js:126:27
    at step (C:\Users\jarajput\AppData\Roaming\npm\node_modules\open-swagger-ui\dist\app.js:33:23)
    at Object.throw (C:\Users\jarajput\AppData\Roaming\npm\node_modules\open-swagger-ui\dist\app.js:14:53)
    at rejected (C:\Users\jarajput\AppData\Roaming\npm\node_modules\open-swagger-ui\dist\app.js:6:65)

Error: The given swagger file could not be found

❯ open-swagger-ui ./open-api-v2.yaml --open
Error: The given swagger file (/home/dsun/workspace/.../open-api-v2.yaml) could not be found.
    at /usr/local/lib/node_modules/open-swagger-ui/dist/app.js:126:27
    at step (/usr/local/lib/node_modules/open-swagger-ui/dist/app.js:33:23)
    at Object.throw (/usr/local/lib/node_modules/open-swagger-ui/dist/app.js:14:53)
    at rejected (/usr/local/lib/node_modules/open-swagger-ui/dist/app.js:6:65)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
❯ open-swagger-ui -V
1.0.1
❯ node -v
v14.15.5
❯ npm -v
7.6.3

[BUG?] Can't render the other yaml file

It shown error like this.

Is there anyway to set basePath via cli? Thank you

Doesn't work out of box

Observed behavior on MacOS, node version 14.13.0.:

npm i -g open-swagger-ui
open-swagger-ui https://raw.githubusercontent.com/vajahath/open-swagger-ui/master/tests/swagger.json
# ---->
# ✔ Loading file https://raw.githubusercontent.com/vajahath/open-swagger-ui/master/tests/swagger.json
# Swagger open on port 49887
# Open localhost:49887 in browser and get "404 not found" error