package
Configure http2-proxy middleware with ease for koa.
npm install koa-http2-proxy2GitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
forked from ontola/koa-http2-proxy. On its basis, the following problems are solved 👇
Proxy requests to http://www.example.org
var Koa = require('koa');
var proxy = require('koa-http2-proxy2');
var app = new Koa();
// response
app.use(proxy({ target: 'http://www.example.org' }));
app.listen(3000);
// http://localhost:3000/foo/bar -> http://www.example.org/foo/bar:bulb: Tip: Set the option changeOrigin to true for name-based virtual hosted sites.
$ npm install --save-dev koa-http2-proxy2Proxy middleware configuration.
var proxy = require('koa-http2-proxy2');
var apiProxy = proxy('/api', { target: 'http://www.example.org' });
// \____/ \_____________________________/
// | |
// context options
// 'apiProxy' is now ready to be used as middleware in a server.(full list of koa-http2-proxy2 configuration options)
// shorthand syntax for the example above:
var apiProxy = proxy('http://www.example.org/api');More about the shorthand configuration.
// include dependencies
var Koa = require('koa');
var proxy = require('koa-http2-proxy2');
// proxy middleware options
var options = {
target: 'http://www.example.org', // target host
ws: true, // proxy websockets
pathRewrite: {
'^/api/old-path': '/api/new-path', // rewrite path
'^/api/remove/path': '/path' // remove base path
},
router: {
// when request.headers.host == 'dev.localhost:3000',
// override target 'http://www.example.org' to 'http://localhost:8000'
'dev.localhost:3000': 'http://localhost:8000'
}
};
Providing an alternative way to decide which requests should be proxied; In case you are not able to use the server's path parameter to mount the proxy or when you need more flexibility.
RFC 3986 path is used for context matching.
foo://example.com:8042/over/there?name=ferret#nose
\_/ \______________/\_________/ \_________/ \__/
| | | | |
scheme authority path query fragmentpath matching
proxy({...}) - matches any path, all requests will be proxied.proxy('/', {...}) - matches any path, all requests will be proxied.proxy('/api', {...}) - matches paths starting with /apiproxy(/^\/([a-zA-Z0-9_/-]{1,})$/, {...}) - matches paths with regexpmultiple path matching
proxy(['/api', '/ajax', '/someotherpath'], {...})wildcard path matching
For fine-grained control you can use wildcard matching. Glob pattern matching is done by micromatch. Visit micromatch or glob for more globbing examples.
proxy('**', {...}) matches any path, all requests will be proxied.proxy('**/*.html', {...}) matches any path which ends with .htmloption.pathRewrite: object/function, rewrite target's url path. Object-keys will be used as RegExp to match paths.
// rewrite path
pathRewrite: {'^/old/api' : '/new/api'}
// remove path
pathRewrite: {'^/remove/api' : ''}
// add base path
pathRewrite: {'^/' : '/basepath/'}
// custom rewriting
pathRewrite: function (path, req) { return path.replace('/api', '/base/api') }option.router: object/function, re-target option.target for specific requests.
// Use `host` and/or `path` to match requests. First match will be used.
// The order of the configuration matters.
Use the shorthand syntax when verbose configuration is not needed. The context and option.target will be automatically configured when shorthand is used. Options can still be used if needed.
proxy('http://www.example.org:8000/api');
// proxy('/api', {target: 'http://www.example.org:8000'});
proxy('http://www.example.org:8000/api/books/*/**.json');
// proxy('/api/books/*/**.json', {target: 'http://www.example.org:8000'});
proxy('http://www.example.org:8000/api');
// proxy('/api', {target: 'http://www.example.org:8000'});// verbose api
proxy('/', { target: 'http://echo.websocket.org', ws: true });
// shorthand
proxy('http://echo.websocket.org', { ws: true });
// shorter shorthand
proxy('ws://echo.websocket.org');In the previous WebSocket examples, http-proxy-middleware relies on a initial http request in order to listen to the http upgrade event. If you need to proxy WebSockets without the initial http request, you can subscribe to the server's http upgrade event manually.
var wsProxy = proxy('ws://echo.websocket.org');
var app = new Koa();
app.use(wsProxy);
var server = app.listen(3000);
server.on('upgrade', wsProxy.upgrade); // <-- subscribe to http 'upgrade'Run the test suite:
# install dependencies
$ yarn
# linting
$ yarn lint
$ yarn lint:fix
# building (compile typescript to js)
$ yarn build
# unit tests
$ yarn test
# code coverage
$ yarn coverThe MIT License (MIT)
Copyright for portions of this project are held by Steven Chim, 2015-2019 as part of http-proxy-middleware. All other copyright for this project are held by Ontola BV, 2019.
proxy('/*.html', {...}) matches paths directly under path-absoluteproxy('/api/**/*.html', {...}) matches requests ending with .html in the path of /apiproxy(['/api/**', '/ajax/**'], {...}) combine multiple patternsproxy(['/api/**', '!**/bad.json'], {...}) exclusionNote: In multiple path matching, you cannot use string paths and wildcard paths together.
custom matching
For full control you can provide a custom function to determine which requests should be proxied or not.
/**
* @return {Boolean}
*/
var filter = function(pathname, req) {
return pathname.match('^/api') && req.method === 'GET';
};
var apiProxy = proxy(filter, { target: 'http://www.example.org' });option.logLevel: string, ['debug', 'info', 'warn', 'error', 'silent']. Default: 'info'
option.logProvider: function, modify or replace log provider. Default: console.
// simple replace
function logProvider(provider) {
// replace the default console log provider.
return require('winston');
}// verbose replacement
function logProvider(provider) {
var logger = new (require('winston')).Logger();
var myCustomProvider = {
log: logger.log,
debug: logger.debug,
info: logger.info,
warn: logger.warn,
error: logger.error
};
return myCustomProvider;
}option.onError: function, subscribe to http-proxy's error event for custom error handling.
function onError(err, ctx) {
ctx.response.status = 500;
ctx.response.body =
'Something went wrong. And we are reporting a custom error message.';
}option.onProxyRes: function, subscribe to http-proxy's proxyRes event.
function onProxyRes(proxyRes, ctx) {
proxyRes.headers['x-added'] = 'foobar'; // add new header to response
delete proxyRes.headers['x-removed']; // remove header from response
}option.onProxyReq: function, subscribe to http-proxy's proxyReq event.
function onProxyReq(proxyReq, ctx) {
// add custom header to request
proxyReq.setHeader('x-added', 'foobar');
// or log the req
}option.onUpgrade: function, called before upgrading a websocket connection.
onUpgrade: async ctx => {
// add session middleware to the websocket connection
// see option.app
await session(ctx, () => {});
};option.app: koa app, used to generate a koa ctx to be used in onUpgrade. If left blank, a object containing only req will be used as context
option.headers: object, adds request headers. (Example: {host:'www.example.org'})
option.target: url string to be parsed with the url module
option.ws: true/false: if you want to proxy websockets
option.xfwd: true/false, adds x-forward headers
option.changeOrigin: true/false, Default: false - changes the origin of the host header to the target URL
option.proxyTimeout: timeout (in millis) when proxy receives no response from target
option.proxyName: Proxy name used for Via header
option.logs: true/false: Whether to enable log printing, default false
Estimated unpacked size across 19 packages.
1.7 MB
Includes dependencies.
^4.0.1
4.0.3
^4.0.2
4.0.8
^5.0.43
5.0.53
^1.1.2
2.1.1
1.0.0
1.0.0