Caching

Caching integration is provided using the Stash library, and it used for two purposes currently:

1. Caching request results to be used as a fallback when the service is unavailable.
2. Storing the state of circuit breakers.

Note that preferring cache results even when the remote service is available is not currently implemented. This is a future consideration.

Specifying caching config in the main description

The caching config should use the cache key in the master description array.

Example of redis caching:

// Master description array
[
    ...
    'cache' => [
        'driver' => [
            'name' => 'Redis',
            'options' => [
                'servers' => [
                    ['hostname.or.ip.of.redis.server', 6379]
                ]
            ]
        ],
        'namespace' => 'MyNamespace'
    ]
]

Top level attributes

Name	Value	Required	Description
driver	array	yes	Driver config, see below
namespace	string	no	A namespace to isolate your cache keys.

Driver config

Name	Value	Required	Description
name	string	yes	Much match a supported Stash driver
options	array	yes	A simple array of options to be used for the driver.

Todo

1. Allow the driver to be a callable, that will build and return a driver object. This way you can build composite drivers.
2. Build out preferred caching, with options to prefer cached results even when remote service is available.