feat(proxy-backend): more proxy config tweaks and docs

This commit is contained in:
Fredrik Adelöw
2020-08-26 16:18:21 +02:00
parent d0cce48b14
commit 6d774764cd
7 changed files with 95 additions and 20 deletions
+44 -2
View File
@@ -19,8 +19,8 @@ const proxyEnv = useHotMemoize(module, () => createEnv('proxy'));
const service = createServiceBuilder(module)
.loadConfig(configReader)
/** several different routers */
.addRouter('/', await proxy(proxyEnv));
/** ... other routers ... */
.addRouter('/proxy', await proxy(proxyEnv, '/proxy'));
```
2. Start the backend
@@ -31,6 +31,48 @@ yarn workspace example-backend start
This will launch the full example backend.
## Configuration
Example:
```yaml
# in app-config.yaml
proxy:
'/simple-example': http://simple.example.com:8080
'/larger-example/v1':
target: http://larger.example.com:8080/svc.v1
headers:
Authorization:
$secret:
env: EXAMPLE_AUTH_HEADER
```
Each key under the proxy configuration entry is a route to match, below the prefix that the proxy
plugin is mounted on. For example, if the backend mounts the proxy plugin as `/proxy`,
the above configuration will lead to the proxy acting on backend requests to
`/proxy/simple-example/...` and `/proxy/larger-example/v1/...`.
The value inside each route is either a simple URL string, or an object on the format accepted by
[http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware).
If the value is a string, it is assumed to correspond to:
```yaml
target: <the string>
changeOrigin: true
pathRewrite:
'^<url prefix><the string>/': '/'
```
When the target is an object, it is given verbatim to `http-proxy-middleware` except with the
following caveats for convenience:
- If `changeOrigin` is not specified, it is set to `true`. This is the most commonly useful value.
- If `pathRewrite` is not specified, it is set to a single rewrite that removes the entire route. In the
above example, a rewrite of `'^/proxy/larger-example/v1/': '/'` is added. That means that a request to
`/proxy/larger-example/v1/some/path` will be translated to a request to
`http://larger.example.com:8080/svc.v1/some/path`.
## Links
- [http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware)