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 install koa-nginx-plus --save

Usage

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

const koa         = require('koa');
const bodyParser  = require('koa-bodyparser');
const koaNginx    = require('koa-nginx-plus');

const app = new koa();
const errHandle = function (e, req, res) {
    res.writeHead(200, {
        'Content-Type': 'application/json;charset=utf-8'
    })
    res.end(JSON.stringify({
        returnCode: '200',
        returnData: false,
        returnInfo: 'proxy error!',
        succ: false
    }))
}
const options = [{
    "host": "http://127.0.0.1:3000/",
    "context": "terminal",
    "errHandle": errHandle
}];
app.use(koaNginx.proxy(options));
//the bodyParser middleware must be after koa-nginx
app.use(bodyParser());
let server = app.listen();
    

API

Options

Most options based on http-proxy.

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

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.