ReServe #

Table of Contents

• What is ReServe
• Usage
• Config
• Routes
• Interceptors
  • Built In Interceptors
    • cookie
    • cors
    • remove-headers
    • replace-body
    • replace-headers
    • set-headers
    • set-response
• HTTPS

What is ReServe #

ReServe is a server that acts as a reverse proxy, but can also alter the responses for things like secure cookies and redirects where the backend service provides domain names.

It supports either HTTP or HTTPS. It is designed for web developers who need to test against live APIs that don't support CORS for local development or utilize cookies that are locked to a domain or are secure.

Usage #

Installing

dart pub global activate reserve

Running

reserve [(-c || --config) configfile.yaml]

For more information on the configuration, see the config section below.

Config #

The ReServe configuration has a search path. It utilizes a search path to locate the confiration which is:

1. If a config param is set, the file passed in that parameter.
2. reserve.yaml in the current directory.
3. web_dev_config.yaml in the current directory, utilizing the reserve key.
4. pubspec_overrides.yaml in the current directory, utilizing the reserve key.
5. pubspec.yaml in the current directory, utilizing the reserve key.

Schema

Example

vars:
  api-server: https://api.example.com
  host: localhost
  port: 8080
  web-server: https://www.example.com
host: ${vars.host}
port: ${vars.port}
routes:
  /api/:
    log: fine
    redirect: ${vars['api-server']}
    interceptors:
      - type: cookie
        with:
          allow-secure: false
  /:
    log: warn
    redirect: ${vars['web-server']}
    interceptors:
      - type: remove-headers
        with:
          headers:
            - cache-control
            - pragma
      - type: cookie
        with:
          allow-secure: false
      - type: replace-body
        with:
          from: ${vars['api-server']}
          replace: http://${vars.host}:${vars.port}

Vars #

A section that contains variables. The viarbles may not reference other variables, however, they can be template expressions.

For example, let's say you have a local configuration file named: dev_config.yaml...

api-server: https://api.example.com
key-not-for-an-api: dEfinateLyN0t@nAp!K3y

... and you want to store that in a variable named "config". To do so, you could create a vars section like:

vars:
  # yaon.decode() // handles either YAML or JSON seamlessly as an input
  # File(path).readAsStringSync // Reads a file using the synchronous I/O
  config: ${yaon.decode(File('dev_config.yaml').readAsStringSync())}

Then if you wanted to reference those entries, you could create a route as follows:

routes:
  /api/:
    redirect: ${vars.config['api-server']}
    interceptors:
      - type: set-headers
        with:
          headers:
            x-key-not-for-apis: ${vars.config['key-not-for-an-api']}

Routes #

The routes are a key / value pair. The key is the path to listen on for the route. Every URL prefixed by that value will be matched to the route. In RegExp form, it's effectively ${key}.*.

Routes are evaluated in order and the first match is used. If no route matches then a 404 will be thrown.

Schema

Interceptors #

Built In Interceptors #

cookie

Performs cookie modifications to make it appear as if the cookies are sent directly between the source and target without any middleware.

Parameters

cors

Automatically responds to OPTIONS based requests with CORS information and augments responses with the same CORS information.

Parameters

remove-headers

Removes the headers with the given keys from the request and / or response.

Parameters

replace-body

Replaces all instances of from in the response body with the value in replace. No-ops when the body is not a textual content type.

Parameters

replace-headers

Replaces all instances of from in the headers with the value in replace.

Parameters

set-headers

Sets the given headers on the request and / or response.

Parameters

set-response

Performs cookie modifications to make it appear as if the cookies are sent directly between the source and target without any middleware.

Parameters

HTTPS #

Information related to the security context that is built from a certificate chain and private key.

Parameters