egg-bee

It is possible that this language document update is out of sync.

A fully configurable client request proxy plugin for egg.

Install

$ npm i egg-bee --save

Usage & Configuration

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

// config/config.default.js
module.exports = appInfo => {
  const config = {
    bee: {
      serviceMap: null, // service map list, a path or object, if no configuration will find service.bee.config.js in baseDir.
      serviceIdent: 'service', // Service identification, That is property name of params.
      app: true, // Mount to the app object
      mock: ['test_service_one', ['test_service_two', 'mock']],// ['service name', ['service name', 'mock data path']]
    }
  };
  return config;
};

// service.bee.config.js
module.exports = {
  test_service_one: [{
    path: 'http://localhost:81/V1/test_service_one'
  }, {
    path: 'http://localhost:82/V1/test_service_one'
  }]
};

// app/mock/test_service_one/list.js
// The path to the mock file uses the same path as the interface
module.exports = {
  status: 0,
  data_list: [{
    id: '007',
    name: 'leon'
  }],
  total: 1,
  index: 1,
  size: 15,
  msg: "test data"
}

// useing in controller
const Controller = require('egg').Controller;

class ApiController extends Controller {
  async index() {
    const res = await this.ctx.bee.collect(option);
    this.ctx.body = res;
  }
};

module.exports = ApiController;

// useing in service
module.exports = app => {
  class ApiService extends app.Service {
    async index(req) {
      const res = await app.bee.collect(option)
      return res
    }
  }
  return ApiService
}

// app/router.js
module.exports = app => {
  const { router, controller } = app;
  // :service is serviceIdent configuration of bee.
  // plugin will match service configuration use ':service'. and add '/*' on the after.
  router.all('/api/:service/*', controller.api.index);
};

Api

bee.collect(option)

option:

• test(res)

A test function of disaster recovery, accept res and return a boolean, if run disaster recovery will useing follow-up service configuration request the server again.

• mixin

A options object, to customize HttpClient.Details.

but method and data is always use property of ctx.

bee.curl(url, option)

just like ctx.curl，but the difference is that url will start with "service name".

// in controller
const { bee, header } = this.ctx;
const checkLogin =  bee.curl('test_service_one/islogin', {
  headers: header,
  method: 'GET',
  contentType: 'json',
  dataType: 'json',
});

License

MIT