http-proxy-middleware
Advanced tools
Package description
The http-proxy-middleware package is a Node.js package that provides an HTTP proxy as a middleware for use with Node.js applications, particularly in conjunction with frameworks like Express. It allows developers to easily set up proxy rules to forward requests to other servers, which is useful for tasks like API forwarding, logging, handling CORS, and more.
Proxy requests
This feature allows you to proxy requests to another server. In this example, all requests to '/api' on the local server are forwarded to 'http://www.example.org'.
const { createProxyMiddleware } = require('http-proxy-middleware');
const apiProxy = createProxyMiddleware('/api', { target: 'http://www.example.org' });
app.use('/api', apiProxy);Path Rewriting
This feature allows you to rewrite the path of the request URL before it gets proxied. In this example, the path '/api' is removed before the request is forwarded to 'http://www.example.org'.
const { createProxyMiddleware } = require('http-proxy-middleware');
const apiProxy = createProxyMiddleware('/api', {
target: 'http://www.example.org',
pathRewrite: { '^/api': '' }
});
app.use('/api', apiProxy);Custom Routing Logic
This feature allows you to implement custom routing logic. In this example, only GET requests to paths starting with '/api' are proxied to 'http://www.example.org'.
const { createProxyMiddleware } = require('http-proxy-middleware');
const apiProxy = createProxyMiddleware((pathname, req) => {
return pathname.match('^/api') && req.method === 'GET';
}, { target: 'http://www.example.org' });
app.use(apiProxy);Handling WebSockets
This feature allows you to proxy WebSocket connections. In this example, WebSocket connections to '/socket' are proxied to 'ws://www.example.org'.
const { createProxyMiddleware } = require('http-proxy-middleware');
const wsProxy = createProxyMiddleware('/socket', {
target: 'ws://www.example.org',
ws: true
});
app.use('/socket', wsProxy);express-http-proxy is similar to http-proxy-middleware but is specifically designed for use with Express. It offers similar features for proxying HTTP requests but may have different configuration options and middleware setup.
node-http-proxy is a full-featured HTTP proxy library for Node.js, which http-proxy-middleware is built upon. It provides more low-level control over proxying but requires more setup compared to the convenience middleware layer provided by http-proxy-middleware.
Redbird is a reverse proxy library for Node.js with built-in support for clustering, HTTP2, LetsEncrypt, and more. It is more feature-rich and suitable for more complex proxying needs compared to http-proxy-middleware, which is simpler and more focused on middleware use cases.
Readme
The one-liner proxy middleware for connect, express and browser-sync
$ npm install --save-dev http-proxy-middleware
Configure the proxy middleware.
var proxyMiddleware = require('http-proxy-middleware');
var proxy = proxyMiddleware('/api', {target: 'http://www.example.org'});
// \____/ \________________________________/
// | |
// context options
// 'proxy' is now ready to be used in a server.
'/api' or ['/api', '/ajax']. (more about context matching)A simple example with express server.
// include dependencies
var express = require('express');
var proxyMiddleware = require('http-proxy-middleware');
// configure proxy middleware
var context = '/api'; // requests with this path will be proxied
var options = {
target: 'http://www.example.org', // target host
changeOrigin: true // needed for virtual hosted sites
};
// create the proxy
var proxy = proxyMiddleware(context, options);
// use the configured `proxy` in web server
var app = express();
app.use(proxy);
app.listen(3000);
See more examples.
Tip: For name-based virtual hosted sites, you'll need to use the option changeOrigin and set it to true.
http-proxy-middleware is compatible with the following servers:
(DEPRECATED) option.proxyHost: Use option.changeOrigin = true instead.
option.pathRewrite: object, rewrite target's url path. Object-keys will be used as RegExp to match paths.
{
"^/old/api" : "/new/api", // rewrite path
"^/remove/api" : "" // remove path
}
The following options are provided by the underlying http-proxy.
path (useful for proxying to proxies)Undocumented options are provided by the underlying http-proxy.
{host:'www.example.org'}Request URL's path-absolute and query will be used for context matching .
http://example.com:8042/over/there?name=ferret#nose/over/there?name=ferrethttp-proxy-middleware offers several ways to decide which requests should be proxied:
path matching
'/' - matches any path, all requests will be proxied.'/api' - matches paths starting with /apimultiple path matching
['/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.
** matches any path, all requests will be proxied.**.html matches any path which ends with .html/*.html matches paths directly under path-absolute/api/**.html matches requests ending with .html in the path of /api['/api/**', '/ajax/**'] combine multiple patterns['/api/**', '!**/bad.json'] exclusionTo run and view the proxy examples, clone the http-proxy-middleware repo and install the dependencies:
$ git clone https://github.com/chimurai/http-proxy-middleware.git
$ cd http-proxy-middleware
$ npm install
Then run whichever example you want:
$ node examples/connect
Or just explore the proxy examples' sources:
examples/connect - connect proxy middleware exampleexamples/express - express proxy middleware exampleexamples/browser-sync - browser-sync proxy middleware exampleTo run the test suite, first install the dependencies, then run:
# unit tests
$ npm test
# code coverage
$ npm run cover
The MIT License (MIT)
Copyright (c) 2015 Steven Chim
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.
FAQs
The one-liner node.js proxy middleware for connect, express, next.js and more
We found that http-proxy-middleware demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.