egg-dhb-framework v1.1.1

dhb-framework

订货宝egg框架 可参考 bff-user 项目

集成

swagger, //swagger 文档 prometheus,jaeger, //项目监控 egg-dhb-permission //鉴权 DHBLogs //日志 jaeger //链路追踪

定义了

inner 接口地址

QuickStart

$ npm i egg-dhb-framework

publish your framework to npm, then change app's framework config:

使用

// {app_root}/index.js
{
  "name": "egg-dhb-framework",
  "egg": {
    "framework": "egg-dhb-framework"
  }
}

//typings/index.d.ts 添加

export * from 'egg-dhb-framework';

// 使用 枚举Status  返回对象基类 RespModel
import { Status ,RespModel } from 'egg';

//基类 RespModel
interface RespModel<T> {
        code: number;
        message?: string;
        action_time?: number;
        data?: T;
    }

//可以看情况 替换  @eggjs/tegg 为 egg-dhb-framework
import { HTTPController, ...} from '@eggjs/tegg';
// egg-dhb-framework
import { HTTPController, ...} from 'egg-dhb-framework';

// config/plugin.ts
//鉴权
permission: {
  enable: true,
},
//链路跟踪
jaeger: {
  enable: true,
},
//服务监控
prometheus: {
  enable: true,
},
//文档插件
swaggerdoc: {
  enable: true,
},
//请求日志记录 
DHBLogs:{
    enable: true,
}

// config/config.{evn}.ts
//鉴权
import whitePath from './whitePath';
config.permission = {
    whitePath: ['xxx/xxx'], // 写上不添加权限的接口
    url: 'http://',
}

//config/config.prod.ts 
//swagger 配置
config.swaggerdoc = {
    enable: false,
}

可以使用inner 接口

  ctx.app.config.innerHost //inner 接口地址

删除

  //删除  middleware/permission.js

  //package.json 删除 egg-tracer插件 有冲突
  

问题 & 意见

Please open an issue here.