egg-swagger

egg plugin，support swagger-ui 2.0.

Install

1$ npm i egg-swagger --save

Usage

1// {app_root}/config/plugin.js
2exports.swagger = {
3  enable: true,
4  package: 'egg-swagger',
5};

Configuration

1// {app_root}/config/config.default.js
2exports.swagger = {
3  enable: true,
4  mountPath: '/test-mount', // swagger-ui  address  <domain>/test-mount
5  swaggerFilePath: '/test-swagger.json', // swagger file default path
6  enableGoogleFont: false,
7};

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

Example

• swagger-ui 对外开放 restful api

Tips

搭配 https://github.com/TheOne1006/egg-connector-remote 可直接生成对应的 swagger 数据

依赖说明

swagger.json 规则来自于 https://editor.swagger.io/?_ga=2.41951072.471192285.1510301833-940518916.1510301833#/

Questions & Suggestions

Please open an issue here.

License

MIT