@4geit/swg-dereference-swagger-helper 中文文档教程
@4geit/swg-dereference-swagger-helper
取消引用 swagger 文件并返回带有普通 swagger 作为 js 对象的 promise
Installation
- 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
或使用 yarn
使用以下命令:
yarn add @4geit/swg-dereference-swagger-helper
- 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')
// ...
并将其与您的端点控制器之一一起使用,如下所示:
// ...
// resolve swagger
const { resolved: { definitions: { SwgSomeModel } } } = await swgDereferenceSwaggerHelper(path.resolve(__dirname, '../swagger.yaml'))
// ...
@4geit/swg-dereference-swagger-helper
dereference swagger file and returns a promise with the plain swagger as js object
Installation
- 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
- 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'))
// ...