@4geit/swg-dereference-swagger-helper

1.31.0 • Public • Published

@4geit/swg-dereference-swagger-helper npm version


dereference swagger file and returns a promise with the plain swagger as js object

Installation

  1. A recommended way to install @4geit/swg-dereference-swagger-helper is through npm package manager using the following command:
npm i @4geit/swg-dereference-swagger-helper --save

Or use yarn using the following command:

yarn add @4geit/swg-dereference-swagger-helper
  1. All you have to do is to import the @4geit/swg-dereference-swagger-helper package in your controller or mock file as below:
// ...
const swgDereferenceSwaggerHelper = require('@4geit/swg-dereference-swagger-helper')
// ...

And use it with one of your endpoint controller as below:

// ...
// resolve swagger
const { resolved: { definitions: { SwgSomeModel } } } = await swgDereferenceSwaggerHelper(path.resolve(__dirname, '../swagger.yaml'))
// ...

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.31.0
    0
    • latest

Version History

Package Sidebar

Install

npm i @4geit/swg-dereference-swagger-helper

Weekly Downloads

0

Version

1.31.0

License

MIT

Last publish

Collaborators

  • geraldinestarke
  • fabianstarke
  • canercandan