Koa Proxies with router config - Forked from koa-proxies and rewrited!

Koa@2.x/next middlware for http proxy

Add router config like http-proxy-middleware Powered by http-proxies / http-proxy-middleware

Installation

1$ npm install koa-proxies-router --save

Options

http-proxy events

1options.events = {
2  error(err, req, res) {},
3  proxyReq(proxyReq, req, res) {},
4  proxyRes(proxyRes, req, res) {}
5}

log option

1// enable log
2options.logs = true; // or false
3
4// custom log function
5options.logs = (ctx, target) {
6  console.log('%s - %s %s proxy to -> %s', new Date().toISOString(), ctx.req.method, ctx.req.oldPath, new URL(ctx.req.url, target))
7}

Usage

1// dependencies
2const Koa = require('koa')
3const proxy = require('koa-proxies')
4const httpsProxyAgent = require('https-proxy-agent')
5
6const app = new Koa()
7
8// middleware
9app.use(proxy('/octocat', {
10  target: 'https://api.github.com/users', // if router config exist this will be ignored
11  router: (req) {
12    if (req.query._proxy) {
13      return _proxy
14    }
15    return 'https://api.github.com/users',
16  },
17  changeOrigin: true,
18  agent: new httpsProxyAgent('http://1.2.3.4:88'), // if you need or just delete this line
19  rewrite: path => path.replace(/^\/octocat(\/|\/\w+)?$/, '/vagusx'),
20  logs: true
21}))