41 lines
1.9 KiB
Markdown
41 lines
1.9 KiB
Markdown
[](http://travis-ci.org/andrewrk/node-proxy-middleware)
|
|
|
|
### Usage:
|
|
|
|
```js
|
|
var connect = require('connect');
|
|
var url = require('url');
|
|
var proxy = require('proxy-middleware');
|
|
|
|
var app = connect();
|
|
app.use('/api', proxy(url.parse('https://example.com/endpoint')));
|
|
// now requests to '/api/x/y/z' are proxied to 'https://example.com/endpoint/x/y/z'
|
|
|
|
//same as example above but also uses a short hand string only parameter
|
|
app.use('/api-string-only', proxy('https://example.com/endpoint'));
|
|
```
|
|
|
|
### Documentation:
|
|
|
|
`proxyMiddleware(options)`
|
|
|
|
`options` allows any options that are permitted on the [`http`](http://nodejs.org/api/http.html#http_http_request_options_callback) or [`https`](http://nodejs.org/api/https.html#https_https_request_options_callback) request options.
|
|
|
|
Other options:
|
|
- `route`: you can pass the route for connect middleware within the options, as well.
|
|
- `via`: by default no [via header](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.45) is added. If you pass `true` for this option the local hostname will be used for the via header. You can also pass a string for this option in which case that will be used for the via header.
|
|
- `cookieRewrite`: this option can be used to support cookies via the proxy by rewriting the cookie domain to that of the proxy server. By default cookie domains are not rewritten. The `cookieRewrite` option works as the `via` option - if you pass `true` the local hostname will be used, and if you pass a string that will be used as the rewritten cookie domain.
|
|
- `preserveHost`: When enabled, this option will pass the Host: line from the incoming request to the proxied host. Default: `false`.
|
|
|
|
### Usage with route:
|
|
|
|
```js
|
|
var proxyOptions = url.parse('https://example.com/endpoint');
|
|
proxyOptions.route = '/api';
|
|
|
|
var middleWares = [proxy(proxyOptions) /*, ...*/];
|
|
|
|
// Grunt connect uses this method
|
|
connect(middleWares);
|
|
```
|