Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
open-swagger-ui
Advanced tools
A easy cli to open swagger(.json or .yaml) files in Swagger UI
Weekly downloads
Readme
An easy CLI to open swagger.json
or .yaml
files in Swagger UI.
$ open-swagger-ui ./swagger.json --open # done !
Requires Node >=10
.
From npm,
npm i -g open-swagger-ui
From Github Package Registry. (Guide).
Type definitions are bundled with this package.
$ 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
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
.
(Project scaffolded with ts-np-generator)
MIT © Vajahath Ahmed
FAQs
A easy cli to open swagger(.json or .yaml) files in Swagger UI
The npm package open-swagger-ui receives a total of 1,714 weekly downloads. As such, open-swagger-ui popularity was classified as popular.
We found that open-swagger-ui demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.