1.3.3 • Published 5 years ago

egg-swaggerbox v1.3.3

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

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