koa2-nginx

koa2-nginx

Fork by koa-nginx

Middleware for koa2. Reverse proxy middleware for koa. Proxy resources on other servers, such as Java services, and other node.js applications. Based on http-proxy library.

Require

node v7.x +

Installation

First install node.js(v7.6.0 or higher). Then:

$ npm i koa2-nginx --save

Usage

When you request url contains terminal, it will transmit to http://127.0.0.1:3000/ !

const Koa = require('koa');
const Proxy = require('koa-nginx');
const app = new Koa();
const Ngnix = Proxy.proxy({
  proxies: [
    {
      host: 'http://localhost:3333/',
      context: '/user/:id'
    },
  ]
});
app.use(Ngnix);
app.listen(3000);
    

API

Options

• logLevel logging level。unrequired，String，default 'info'. logging levels are prioritized from 0 to 5 (highest to lowest):

logLevel	level
error	0
warn	1
info	2
verbose	3
debug	4
silly	5

• proxyTimeout timeout for outgoing proxy requests.unrequired,the values are in millisecond,Number,default 30000

• proxies koa-ngnix important parameter,required,expect get array,Each of the internal objects is a proxy combination, and some of the internal parameters can override globally parameters of the same name.

  • target url string to be parsed with the url module
  • context Local proxy root address,required,string format or path match
  • logs unrequired，Boolean, default true
  • rewrite unrequired，Function
  • proxyTimeout unrequired，Number
  • event
    • handleReq This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to "web",include proxyReq,req,res,options
    • handleRes This event is emitted if the request to the target got a response,include proxyRes,req,res
    • handleError The error event is emitted if the request to the target fail,include err,req,res

     const Ngnix = Proxy.proxy({
       proxies: [
         {
           ...
           event: {
             handleReq: proxyObj => {
               { proxyReq, req, res, options } = proxyObj;
               proxyReq.setHeader('token', '123456')
               console.log(proxyReq.getHeader('token'))
             },
             handleRes: proxyObj => {
               { proxyRes, req, res, options } = proxyObj;
               proxyRes.headers.token = req.headers.customToken;
             },
             handleError: proxyObj => {
               console.log('this is proxy error handler')
             }
           }
         }
       ]
     });
     ```
  
  

Most options based on http-proxy.

• host: the end point server
• context: the request url contains the 'context' will be proxy

const Ngnix = Proxy.proxy({
  proxies: [
    {
      target: 'http://127.0.0.1:3000',
      context: 'api', // match xxx.xxx.xxx/api or xxx.xxx.xxx/api*
      logs: false,
      rewrite: path => path.replace('api', 'rewriteApi'),
      proxyTimeout: 10000,
    },
    {
      target: 'http://127.0.0.1:3001',
      context: '/user/:id', // match xxx.xxx.xxx/user/1
    },
  ],
  proxyTimeout: 5000,
  logLevel: 'debug',
  ...
});
app.use(Ngnix);

License

MIT License

Copyright (c) 2017 yong.liu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.