jwilson64/ninja-proxy

Ninja Proxy

What is it?

This is based off of Zeit's micro-proxy

The goal is to give a user a quick way to spin up a proxy.

Usage

Firstly, install the package:

npm i -g ninja-proxy

Then add following rules to a filename called rules.json:

{
  "rules": [
    { "pathname": "/home", "destination": "http://localhost:3000", "rewrite": "/" },
    { "pathname": "/", "destination": "http://localhost:3000" }
  ]
}

Visit path alias documentation to learn more about rules.

Run the proxy server with:

ninja-proxy -r rules.json -p 9000 Now you can access the proxy via: http://localhost:9000

Programmatic Usage

You can run the proxy programmatically inside your codebase. For that, add ninja-proxy to your project with:

npm install ninja-proxy

Then create the proxy server like this:

const { createProxy } = require('ninja-proxy')
const proxy = createProxy([
  { "pathname": "/", "destination": "http://localhost:3000" }
])

proxy.listen(9000, (err) => {
  if (err) {
    throw err
  }
  console.log(`> Ready on http://localhost:9000`)
})

Available Options

Option	Required	Description	Example
pathname	yes	The path to listen for	/home
destination	yes and no	Required if not a stub. The server your traffic is going to	http://localhost:3000
rewrite	no	Rewrite your path to specific path on the server. Example: /home to /	/
headers	no	a JSON element of extra headers to pass along	{ x-forwarded-host: 'mydomain.com'}
methods	no	array of HTTP methods that may be used on this endpoint. If blank all are valid	['GET', 'POST', 'PUT']
stub	yes and no	Required if it is a stub. This is JSON data to return if you want to mock an API	{"data": "test"}