Introduction

A koa2 middleware by means of http-proxy-middleware.

中文

Install

$ npm install --save-dev koa2-proxy-middleware

Usage

This is a very simple usage. If you are familiar with the use of http-proxy-middleware and path-to-regexp.

Example

1const Koa = require('koa');
2const proxy = require('koa2-proxy-middleware');
3const bodyparser = require('koa-bodyparser');
4
5const app = new Koa();
6
7const options = {
8  targets: {
9    '/user': {
10      // this is option of http-proxy-middleware
11      target: 'http://localhost:3000', // target host
12      changeOrigin: true, // needed for virtual hosted sites
13    },
14    '/user/:id': {
15      target: 'http://localhost:3001',
16      changeOrigin: true,
17    },
18    // (.*) means anything
19    '/api/(.*)': {
20      target: 'http://10.94.123.123:1234',
21      changeOrigin: true,
22      pathRewrite: {
23        '/passager/xx': '/mPassenger/ee', // rewrite path
24      }
25    },
26  }
27}
28
29app.use(proxy(options));
30
31
32app.use(bodyparser({
33  enableTypes:['json', 'form', 'text']
34}));

options

1{
2  targets: {
3    [key]: [option],
4  },
5}

key

The key route that you need to proxy.And through path-to-regexp into regexp. This is mean:

1const regexp = pathToRegexp('route-key');
2regexp.test(ctx.req.path);

option

The option corresponding to key and like http-proxy-middleware.

Tips

Bodyparser need to after proxy-middleware when request method is POST. Otherwise there will be a delay. I think this is a bug of bodyparser.