Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnhof/proxy-express
A configurable proxy as express middleware
https://github.com/johnhof/proxy-express
Last synced: 22 days ago
JSON representation
A configurable proxy as express middleware
- Host: GitHub
- URL: https://github.com/johnhof/proxy-express
- Owner: johnhof
- License: mit
- Created: 2015-02-25T22:39:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-03-27T14:23:32.000Z (over 4 years ago)
- Last Synced: 2024-10-04T18:46:43.905Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 7
- Watchers: 5
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
[](https://travis-ci.org/johnhof/proxy-express)
This module is designed to simplify server logic when utilizing 3rd party API's. Several API's can be used in conjunction, and the proxy can be used in tandem with server defined routes.
[demo](https://github.com/johnhof/proxy-express/tree/master/demo) - `$ node ./demo/server`
# Key
- [Server example](#server-example)
- [Proxy Types](#proxy-types)
- [Pure proxy](#pure-proxy)
- [Proxy With Prefix](#proxy-with-prefix)
- [Proxy With Configuration](#proxy-with-confix)
- [Configuration Options](#configuration-options)
- [.prefix](#prefix)
- [.restrict](#restrict)
- [.request](#request)
- [.forceHttps](#forcehttps)
- [.strictSSL](#strictssl)
- [.prepend](#prepend)
- [.followRedirects](#followredirects)
- [.headers](#headers)
- [.query](#query)
- [.form](#form)
- [.pre](#pre)
- [.post](#post)
- [.log](#log)
# Server Example
**Note:** for a fully funcitonal demo, clone and run `node ./demo/server` and take a look at the code [here](https://github.com/johnhof/proxy-express/tree/master/demo)
```javascript
var proxy = require('proxy-express');
var routes = require('/routes');
var server = require('express')();
server.use(routes);
server.use(proxy('api.foo.com', '/foo'));
server.use(proxy('api.bar.com', '/bar'));
server.use(proxy('api.github.com', {
prefix : 'github',
request : {
forceHttps : true,
headers : {
'User-Agent' : 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:24.0) Gecko/20100101 Firefox/24.0',
}
}
}));
server.listen(7000);
```
# Proxy types
## Pure proxy
Forward all requests to the host specified. If `forceHttps` is `true`, all requests to the proxied server will be https
```javascript
server.use(proxy('www.foo.com'), [forceHttps]);
// [METHOD] /* => proxied to the 3rd party server
```
## Proxy With Prefix
Forward all requests to the host specified. Only requests made with the prefix in the URL will be run through the proxy. The prefix will be stripped from the request before it's made to the proxied server. if `forceHttps` is `true`, all requests to the proxied server will be https
```javascript
server.use(proxy('www.foo.com', '/foo', [forceHttps]));
// [METHOD] /users => ignored by proxy
// [METHOD] /foo/users => proxied to [METHOD] //www.foo.com/users
```
## Proxy With Configuration
Allows complex configuration. More details in the [configuration section](#configuration-options)
```javascript
server.use(proxy('ww.foo.com', {
prefix : 'foo',
request : {
forceHttps : true,
headers : {
'User-Agent' : 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:24.0) Gecko/20100101 Firefox/24.0',
}
}
}));
// [METHOD] /users => ignored by proxy
// [METHOD] /foo/users => proxied to [METHOD] https://www.foo.com/users with 'User-Agent' set
```
# Configuration Options
The following configuration options are allowed
## .prefix
Type: `String`
The proxy will match any route with the leading prefix. The prefix will be removed before the request is submitted to the proxied server
```javascript
proxy('www.foo.com', {
prefix : '/foo'
// /foo/test => /test
// /test => ignored by proxy
});
```
## .restrict
Type : `String || RegExp || Array || Function`
Only routes matching the restrictions will be run through the proxy
```javascript
proxy('www.foo.com', {
restrict : 'bar'
// /biz/bar => proxied
// /biz => ignored
});
```
// OR
```javascript
proxy('www.foo.com', {
restrict : /\/bar$/
// /biz/bar => proxied
// /bar/biz => ignored
});
```
// OR
```javascript
proxy('www.foo.com', {
restrict : [/\/bar$/, 'foo']
// /biz/bar => proxied
// /biz/foo/baz => proxied
// /bar/biz => ignored
});
```
// OR
```javascript
proxy('www.foo.com', {
restrict : function(req){
return req.get('force-proxy') !=== undefined
}
// curl -H force-proxy:foobar http://127.0.0.1/anything
// => proxied
});
```
## .request
Type: `Object`
All options set in the request proper will be applied to the proxy request
### .forceHttps
Type: `Boolean`
If true, all requests to the proxied server will be made over https
```javascript
proxy('www.foo.com', {
request : {
forceHttps : true
}
});
```
### .strictSSL
Type: `Boolean`
Default: `true`
Whether or not to do SSL key validation when making requests to the registry via https.
This is similar to the git/npm/request setting of the same name; useful if you're behind a proxy.
```javascript
proxy('www.foo.com', {
request : {
strictSSL : false
}
});
```
### .prepend
Type: `String`
The path to be prepended to every request through the proxy
```javascript
proxy('www.foo.com', {
request : {
prepend : 'foo/v0'
}
});
```
### .followRedirects
Type: `Boolean`
Default: `true`
If true, all redirects returned from the proxied server will be followed before returning content
```javascript
proxy('www.foo.com', {
request : {
followRedirects : false
}
});
```
### .headers
Type: `Object`
Any header key/value pair will override the headers being proxied by to the 3rd party server. Setting a header to `undefined` will remove it from the proxied request
```javascript
proxy('www.foo.com', {
request : {
headers : {
'User-Agent' : 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:24.0) Gecko/20100101 Firefox/24.0',
'accept-language' : undefined // deleted from all proxied requests
}
}
});
```
### .query
Type: `Object`
Any query key/value pair will override the query being proxied by to the 3rd party server
```javascript
proxy('www.foo.com', {
request : {
query : {
type : 'proxied' // /foo => /foo?type=proxied
}
}
});
```
### .form
Type: `Object`
Requires: `bodyParser.json()`
Any form key/value pair will override the form/body being proxied by to the 3rd party server
```javascript
proxy('www.foo.com', {
request : {
form : {
type : 'proxied'
}
}
});
```
## .pre
Type : `function || Array`
The function passed in will be run ad a callback before the request is made. any changes to `proxyObj.reqOpts` will be used in the request. The reqOpts object will be passed directy into the [request module](https://www.npmjs.com/package/request) after the callback is executed. If using this function. please familiarize yourself with the [request module](https://www.npmjs.com/package/request). If an array of functions are submitted, they will be executed synchronously
```javascript
proxy('www.foo.com', {
pre : function (proxyObj) {
// proxyObj contains
// {
// req : Object // express request
// res : Object // express request
// proxyObj : Object // object used in the 'request' module request
// }
return callback();
}
});
```
## .post
Type : `function || Array`
The function passed in will be run ad a callback after the request is made. any changes to `proxyObj.res` and `proxyObj.result` will be used in the response. `proxyObj.result.response` is the response object returned from the [request module](https://www.npmjs.com/package/request). If an array of functions are submitted, they will be executed synchronously
```javascript
proxy('www.foo.com', {
post : function (proxyObj) {
// proxyObj contains
// {
// req : Object // express request
// res : Object // express request
// proxyObj : Object // object used in the 'request' module request
// result : {
// response : Object, // response object from the proxied request
// body : Mixed // response body from the proxied request
// }
// }
return callback();
}
});
```
## .log
Type : `Boolean`
if truthy, the proxy will log out the details of any incoming request/action
```javascript
proxy('www.foo.com', {
log: true
});
```
## Tests
to run tests: `npm install && npm test`
tests must be added for each new feature to maintain coverage