https://github.com/kikooo/thrift-mock

An egg.js plugin provides mock function of thrift interface in various ways
https://github.com/kikooo/thrift-mock

Last synced: about 1 month ago
JSON representation

An egg.js plugin provides mock function of thrift interface in various ways

• Host: GitHub
• URL: https://github.com/kikooo/thrift-mock
• Owner: kikooo
• Created: 2018-04-28T03:44:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-09T23:10:36.000Z (over 2 years ago)
• Last Synced: 2024-10-07T20:49:08.005Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 191 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-github-star - thrift-mock

README

        
# egg-thrift-mock

thrift请求的mock服务，支持多种使用方式。

## 基本配置Config

```javascript

config.thriftMock = {

  TGatewayCityMappingService: {

    idl: path.join(appInfo.baseDir, '/app/service/city-id-transition/CityIdTransition.thrift'),

    service: require('../app/service/city-id-transition/gen-nodejs/TGatewayCityMappingService'),

    port: 9903,

    mockFile: '/app/service/city-id-transition/CityIdTransition.json'

  }

};

```

## 使用方式

### 方式一：开发时在本地启动mock服务器

```javascript

// start.js

const { createServer } = require('egg-thrift-mock');

/* 配置示例

  {

    TSayHelloService: {

      idl: 'test/thrift/hello/hello.thrift',

      service: require('./thrift/hello/gen-nodejs/TSayHelloService'),

      port: 9903

    },

  }

*/

let cfgs = require('./config');

if (typeof cfgs === 'string') {

  cfgs = JSON.parse(cfgs);

}

createServer(cfgs);

```

### 方式二：作为egg插件使用全局对象

```javascript

// app/controller/thrift.js

module.exports = app => class ThriftController extends app.Controller {

  async test() {

    const result = await app.thriftMocker.request('TGatewayCityMappingService', 'getMtCityIdByDpCityId');

    const { ctx } = this;

    ctx.status = 200;

    ctx.body = {

      success: true,

      data: result.data

    };

  }

};

```

### 方式三：作为egg插件做中间件使用

拦截请求，直接请求以下格式url即可。

url举例：

```javascript

const mockUrl = `http://${localhost}/thrift-mock/${serviceName}/${methodName}`

```

### 方式四：自定义数据mock方法

支持mock规则自定义。

使用方法详见`example/custom-mock-example.js`。

## 其他

**欢迎各类纠错和补充。谢谢大家~**