http-proxy-middleware
Node.js proxying made simple. Configure proxy middleware with ease for connect, express, next.js, hono and many more.
Powered by httpxy. A maintained version of http-proxy.
⚠️ Note
This page is showing documentation for version v4.x.x (release notes)
For older documentation:
TL;DR
Proxy /api requests to http://www.example.org
:bulb: Tip: Set the option changeOrigin to true for name-based virtual hosted sites.
// typescript
import express from 'express';
import type { NextFunction, Request, Response } from 'express';
import { createProxyMiddleware } from 'http-proxy-middleware';
import type { Filter, Options, RequestHandler } from 'http-proxy-middleware';
const app = express();
const proxyMiddleware = createProxyMiddleware<Request, Response>({
target: 'http://www.example.org/api',
changeOrigin: true,
});
app.use('/api', proxyMiddleware);
app.listen(3000);
// proxy and keep the same base path "/api"
// http://127.0.0.1:3000/api/foo/bar -> http://www.example.org/api/foo/bar
All httpxy options can be used, along with some extra http-proxy-middleware options.
Table of Contents
Install
npm install --save-dev http-proxy-middleware
Basic usage
Create and configure a proxy middleware with: createProxyMiddleware(config).
import { createProxyMiddleware } from 'http-proxy-middleware';
const apiProxy = createProxyMiddleware({
target: 'http://www.example.org',
changeOrigin: true,
});
// 'apiProxy' is now ready to be used as middleware in a server.
Express Server Example
An example with express server.
// include dependencies
import express from 'express';
import { createProxyMiddleware } from 'http-proxy-middleware';
const app = express();
// create the proxy
/** @type {import('http-proxy-middleware').RequestHandler<import('express').Request, import('express').Response>} */
const exampleProxy = createProxyMiddleware({
target: 'http://www.example.org/api', // target host with the same base path
changeOrigin: true, // needed for virtual hosted sites
});
// mount `exampleProxy` in web server
app.use('/api', exampleProxy);
app.listen(3000);
app.use(path, proxy)
If you want to use the server's app.use path parameter to match requests.
Use pathFilter option to further include/exclude requests which you want to proxy.
app.use(
createProxyMiddleware({
target: 'http://www.example.org/api',
changeOrigin: true,
pathFilter: '/api/proxy-only-this-path',
}),
);
app.use documentation:
Options
http-proxy-middleware options:
pathFilter (string, []string, glob, []glob, function)
Narrow down which requests should be proxied. The path used for filtering is the request.url pathname. In Express, this is the path relative to the mount-point of the proxy.
path matching
createProxyMiddleware({...}) - matches any path, all requests will be proxied when pathFilter is not configured.createProxyMiddleware({ pathFilter: '/api', ...}) - matches paths starting with /api
multiple path matching
createProxyMiddleware({ pathFilter: ['/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.
createProxyMiddleware({ pathFilter: '**', ...}) matches any path, all requests will be proxied.createProxyMiddleware({ pathFilter: '**/*.html', ...}) matches any path which ends with .htmlcreateProxyMiddleware({ pathFilter: '/*.html', ...}) matches paths directly under path-absolutecreateProxyMiddleware({ pathFilter: '/api/**/*.html', ...}) matches requests ending with .html in the path of /apicreateProxyMiddleware({ pathFilter: ['/api/**', '/ajax/**'], ...}) combine multiple patternscreateProxyMiddleware({ pathFilter: ['/api/**', '!**/bad.json'], ...}) exclusion
Note: 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}
*/
const pathFilter = function (path, req) {
return path.match('^/api') && req.method === 'GET';
};
const apiProxy = createProxyMiddleware({
target: 'http://www.example.org',
pathFilter: pathFilter,
});
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, res, options) { return path.replace('/api', '/base/api') }
// custom rewriting, returning Promise
pathRewrite: async function (path, req, res, options) {
const should_add_something = await httpRequestToDecideSomething(path);
if (should_add_something) path += "something";
return path;
}
// `res` is undefined in WebSocket upgrade flows.
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.
router: {
'integration.localhost:3000' : 'http://127.0.0.1:8001', // host only
'staging.localhost:3000' : 'http://127.0.0.1:8002', // host only
'localhost:3000/api' : 'http://127.0.0.1:8003', // host + path
'/rest' : 'http://127.0.0.1:8004' // path only
}
// Custom router function (string target)
router: function(req, res, options) {
return 'http://127.0.0.1:8004';
}
// Custom router function (target object)
router: function(req, res, options) {
return {
protocol: 'https:', // The : is required
host: '127.0.0.1',
port: 8004
};
}
// Asynchronous router function which returns promise
router: async function(req, res, options) {
const url = await doSomeIO();
return url;
}
// NOTE: `res` is undefined in WebSocket upgrade flows.
plugins (Array)
const simpleRequestLogger = (proxyServer, options) => {
proxyServer.on('proxyReq', (proxyReq, req, res) => {
console.log(`[HPM] [${req.method}] ${req.url}`); // outputs: [HPM] GET /users
});
},
const config = {
target: `http://example.org`,
changeOrigin: true,
plugins: [simpleRequestLogger],
};
ejectPlugins (boolean) default: false
If you're not satisfied with the pre-configured plugins, you can eject them by configuring ejectPlugins: true.
NOTE: register your own error handlers to prevent server from crashing.
// eject default plugins and manually add them back
import {
debugProxyErrorsPlugin, // subscribe to proxy errors to prevent server from crashing
errorResponsePlugin, // return 5xx response on proxy error
loggerPlugin, // log proxy events to a logger (ie. console)
proxyEventsPlugin, // implements the "on:" option
} from 'http-proxy-middleware';
createProxyMiddleware({
target: `http://example.org`,
changeOrigin: true,
ejectPlugins: true,
plugins: [debugProxyErrorsPlugin, loggerPlugin, errorResponsePlugin, proxyEventsPlugin],
});
definePlugin helper
Create your own http-proxy-middleware plugin.
(Default plugins are created with definePlugin)
import { createProxyMiddleware, definePlugin } from 'http-proxy-middleware';
const myPlugin = definePlugin((proxyServer, options) => {
// plugin implementation
});
// use configure and use plugin
createProxyMiddleware({
target: `http://example.org`,
plugins: [myPlugin],
});
logger (Object)
Configure a logger to output information from http-proxy-middleware: ie. console, winston, pino, bunyan, log4js, etc...
Only info, warn, error are used internally for compatibility across different loggers.
If you use winston, make sure to enable interpolation: https://github.com/winstonjs/winston#string-interpolation
See also logger recipes (recipes/logger.md) for more details.
createProxyMiddleware({
logger: console,
});
httpxy events
Subscribe to httpxy events with the on option:
createProxyMiddleware({
target: 'http://www.example.org',
on: {
proxyReq: (proxyReq, req, res) => {
/* handle proxyReq */
},
proxyRes: (proxyRes, req, res) => {
/* handle proxyRes */
},
error: (err, req, res) => {
/* handle error */
},
},
});
option.on.error: function, subscribe to httpxy's error event for custom error handling.
function onError(err, req, res, target) {
res.writeHead(500, {
'Content-Type': 'text/plain',
});
res.end('Something went wrong. And we are reporting a custom error message.');
}
option.on.proxyRes: function, subscribe to httpxy's proxyRes event.
function onProxyRes(proxyRes, req, res) {
proxyRes.headers['x-added'] = 'foobar'; // add new header to response
delete proxyRes.headers['x-removed']; // remove header from response
}
option.on.proxyReq: function, subscribe to httpxy's proxyReq event.
function onProxyReq(proxyReq, req, res) {
// add custom header to request
proxyReq.setHeader('x-added', 'foobar');
// or log the req
}
option.on.proxyReqWs: function, subscribe to httpxy's proxyReqWs event.
function onProxyReqWs(proxyReq, req, socket, options, head) {
// add custom header
proxyReq.setHeader('X-Special-Proxy-Header', 'foobar');
}
option.on.open: function, subscribe to httpxy's open event.
function onOpen(proxySocket) {
// listen for messages coming FROM the target here
proxySocket.on('data', hybridParseAndLogMessage);
}
option.on.close: function, subscribe to httpxy's close event.
function onClose(res, socket, head) {
// view disconnected websocket connections
console.log('Client disconnected');
}
httpxy options
The following options are provided by the underlying httpxy library.
option.target: url string to be parsed with the url module
option.forward: url string to be parsed with the url module
option.agent: object to be passed to http(s).request (see Node's https agent and http agent objects)
option.ssl: object to be passed to https.createServer()
option.ws: true/false: if you want to proxy websockets
option.xfwd: true/false, adds x-forward headers
option.secure: true/false, if you want to verify the SSL Certs
option.toProxy: true/false, passes the absolute URL as the path (useful for proxying to proxies)
option.prependPath: true/false, Default: true - specify whether you want to prepend the target's path to the proxy path
option.ignorePath: true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required).
option.localAddress : Local interface string to bind for outgoing connections
option.changeOrigin: true/false, Default: false - changes the origin of the host header to the target URL
option.preserveHeaderKeyCase: true/false, Default: false - specify whether you want to keep letter case of response header key
option.auth : Basic authentication i.e. 'user:password' to compute an Authorization header.
option.hostRewrite: rewrites the location hostname on (301/302/307/308) redirects.
option.autoRewrite: rewrites the location host/port on (301/302/307/308) redirects based on requested host/port. Default: false.
option.protocolRewrite: rewrites the location protocol on (301/302/307/308) redirects to 'http' or 'https'. Default: null.
option.cookieDomainRewrite: rewrites domain of set-cookie headers. Possible values:
false (default): disable cookie rewriting
String: new domain, for example cookieDomainRewrite: "new.domain". To remove the domain, use cookieDomainRewrite: "".
Object: mapping of domains to new domains, use "*" to match all domains.
For example keep one domain unchanged, rewrite one domain and remove other domains:
cookieDomainRewrite: {
"unchanged.domain": "unchanged.domain",
"old.domain": "new.domain",
"*": ""
}
option.cookiePathRewrite: rewrites path of set-cookie headers. Possible values:
false (default): disable cookie rewriting
String: new path, for example cookiePathRewrite: "/newPath/". To remove the path, use cookiePathRewrite: "". To set path to root use cookiePathRewrite: "/".
Object: mapping of paths to new paths, use "*" to match all paths.
For example, to keep one path unchanged, rewrite one path and remove other paths:
cookiePathRewrite: {
"/unchanged.path/": "/unchanged.path/",
"/old.path/": "/new.path/",
"*": ""
}
option.headers: object, adds request headers. (Example: {host:'www.example.org'})
option.proxyTimeout: timeout (in millis) when proxy receives no response from target
option.timeout: timeout (in millis) for incoming requests
option.followRedirects: true/false, Default: false - specify whether you want to follow redirects
option.selfHandleResponse true/false, if set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the proxyRes event
option.buffer: stream of data to send as the request body. Maybe you have some middleware that consumes the request stream before proxying it on e.g. If you read the body of a request into a field called 'req.rawbody' you could restream this field in the buffer option:
import { createProxyServer } from 'httpxy';
import streamify from 'stream-array';
const proxy = createProxyServer();
export default function proxyWithBody(req, res, next) {
proxy.web(
req,
res,
{
target: 'http://127.0.0.1:4003/',
buffer: streamify(req.rawBody),
},
next,
);
}
WebSocket
See recipes/websocket.md for more examples.
// verbose api
createProxyMiddleware({ pathFilter: '/', target: 'http://echo.websocket.org', ws: true });
External WebSocket upgrade
In the previous WebSocket examples, http-proxy-middleware relies on an 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.
When the same middleware instance is attached to multiple servers and ws: true is used, each server needs its own initial HTTP request before upgrades are auto-subscribed.
const wsProxy = createProxyMiddleware({ target: 'ws://echo.websocket.org', changeOrigin: true });
const app = express();
app.use(wsProxy);
const server = app.listen(3000);
server.on('upgrade', wsProxy.upgrade); // <-- subscribe to http 'upgrade'
Intercept and manipulate requests
Intercept requests from downstream by defining on.proxyReq in createProxyMiddleware.
Fix POST request:
Use the pre-provided request interceptor fixRequestBody to fix proxied POST requests when bodyParser is applied before this middleware.
import { createProxyMiddleware, fixRequestBody } from 'http-proxy-middleware';
const proxy = createProxyMiddleware({
on: {
// Fix POST request when `bodyParser` is used
proxyReq: fixRequestBody,
},
});
Modify POST request:
import bodyParser from 'body-parser';
import { createProxyMiddleware, fixRequestBody } from 'http-proxy-middleware';
app.use(bodyParser.json());
app.use(
'/api',
createProxyMiddleware({
target: 'http://www.example.org',
changeOrigin: true,
on: {
proxyReq: (proxyReq, req) => {
if (req.method !== 'POST' || !req.body) {
return;
}
// mutate parsed request body
req.body.injected = 'server-only';
// write mutated body to the proxied request
fixRequestBody(proxyReq, req);
},
},
}),
);
Intercept and manipulate responses
Intercept responses from upstream with responseInterceptor. (Make sure to set selfHandleResponse: true)
Responses which are compressed with brotli, gzip and deflate will be decompressed automatically. The response will be returned as buffer (docs) which you can manipulate.
With buffer, response manipulation is not limited to text responses (html/css/js, etc...); image manipulation will be possible too. (example)
NOTE: responseInterceptor disables streaming of target's response.
Example:
import { createProxyMiddleware, responseInterceptor } from 'http-proxy-middleware';
const proxy = createProxyMiddleware({
/**
* IMPORTANT: avoid res.end being called automatically
**/
selfHandleResponse: true, // res.end() will be called internally by responseInterceptor()
/**
* Intercept response and replace 'Hello' with 'Goodbye'
**/
on: {
proxyRes: responseInterceptor(async (responseBuffer, proxyRes, req, res) => {
const response = responseBuffer.toString('utf8'); // convert buffer to string
return response.replace('Hello', 'Goodbye'); // manipulate response and return the result
}),
},
});
Check out interception recipes for more examples.
Node.js 17+: ECONNREFUSED issue with IPv6 and localhost (#705)
Node.js 17+ no longer prefers IPv4 over IPv6 for DNS lookups.
E.g. It's not guaranteed that localhost will be resolved to 127.0.0.1 – it might just as well be ::1 (or some other IP address).
If your target server only accepts IPv4 connections, trying to proxy to localhost will fail if resolved to ::1 (IPv6).
Ways to solve it:
- Change
target: "http://localhost" to target: "http://127.0.0.1" (IPv4).
- Change the target server to (also) accept IPv6 connections.
- Add this flag when running
node: node index.js --dns-result-order=ipv4first. (Not recommended.)
Additional IPv6 notes:
- Unspecified IPv6 host
http://[::]:port is normalized to loopback (::1) to reach local listeners.
Note: There’s a thing called Happy Eyeballs which means connecting to both IPv4 and IPv6 in parallel, which Node.js doesn’t have, but explains why for example curl can connect.
Debugging
Configure the DEBUG environment variable enable debug logging.
See debug project for more options.
DEBUG=http-proxy-middleware* node server.js
$ http-proxy-middleware proxy created +0ms
$ http-proxy-middleware proxying request to target: 'http://www.example.org' +359ms
Working examples
View and play around with working examples.
Recipes
View the recipes for common use cases.
Compatible servers
http-proxy-middleware is compatible with the following servers:
Sample implementations can be found in the server recipes.
Tests
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 coverage
# check spelling mistakes
$ yarn spellcheck
Changelog
License
The MIT License (MIT)
Copyright (c) 2015-2026 Steven Chim
这是一个 Node.js 中间件，只需一行代码就能创建 HTTP 代理，让你把 /api 这类请求转发到另一个主机。它封装了 httpxy 代理引擎，可以接入 connect、express、next.js、hono、fastify 等服务器。