egg-api-wrap

依赖说明

依赖的 egg 版本

egg-api-wrap 版本 | egg 1.x --- | --- 1.x | 😁 0.x | ❌

依赖的插件

开启插件

// config/plugin.js
exports.apiWrap = {
  enable: true,
  package: 'egg-api-wrap',
};

使用场景

• Why and What: 封装接口返回格式。 尽可能描述详细。
• How:

// 接口 controller中直接使用
class HomeController extends Controller {
  async test(ctx) {
    // 对应返回结果 {status: 0, message: 'success', data: {val:1}}
    ctx.setResult([ 0, 'success' ], {
      val: 1,
    });
  }
}
//建议用法 context中增加CODE变量统一维护接口异常代码
//context.js
exports.CODE = {
    "SUCCESS": [0, 'success'],
    "SYS_ERROR": [1, '系统异常'],
    "DATA_TYPE": [2, '数据类型错误'],
    "DATA_LIMIT": [11, '数据异常']
};
// 接口 controller中使用
class HomeController extends Controller {
  async test(ctx) {
   // 对应返回结果 {status: 1, message: '系统异常', data: {val:1}}
    ctx.setResult(ctx.CODE.SYS_ERROR, {
      val: 1,
    });
  }
}

详细配置

请到 config/config.default.js 查看详细配置项说明。

// config/config.default.js
exports.apiWrap = {
  enable: true,
  match: /\/api\/.*/   // 建议只针对接口开启
};

单元测试

提问交流

请到 egg issues 异步交流。

License

MIT