egg-swaggerbox

1.3.3 • Public • Published

egg-swaggerbox

swagger useful module for egg.

NPM version build status Test coverage David deps Known Vulnerabilities NPM download

Install

$ npm i egg-swaggerbox --save

Usage

// {app_root}/config/plugin.js
exports.swaggerdoc = {
  enable: true,
  package: "egg-swaggerbox"
};

Configuration

// {app_root}/config/config.default.js
exports.swaggerbox = {
  apiInfo: {
    title: "egg-swagger",
    description: "swagger-ui for egg",
    version: "1.0.0"
  },
  ui: {
    prefix: "/",
    dir: path.join(__dirname, "../app/public"),
    dynamic: true,
    preload: false,
    buffer: false,
    maxFiles: 1000
  }
};

see config/config.default.js for more detail.

Questions & Suggestions

Please open an issue here.

License

MIT

Package Sidebar

Install

npm i egg-swaggerbox

Weekly Downloads

1

Version

1.3.3

License

MIT

Unpacked Size

9.12 MB

Total Files

32

Last publish

Collaborators

  • dapixp