nocca | Use Nocca to serve mocks | Mock library

Generally the webservices / endpoints that your application calls should be configurable. When running your application through Nocca your application should send the requests to the Nocca proxy server instead. It is then up to Nocca to either serve a cache or forward the request to the original endpoint.
For Nocca to work for your application you will need to set application specific configuration properties to your Nocca instance. Where you want the Nocca server to run. Provide a port number, or an array of arguments: [portNumber, hostname, backlog]. The array will be applied to the Node.js server.listen function. Nocca will provide the callback argument. By default it will use the Cloud Foundry port if set, or fall back to 8989. A Nocca endpoint is a configuration object that is used to handle an incoming request on the Nocca proxy server (localhost:8989/proxy/* by default). The object should contain the endpoint URL of the target server, and may contain information on how to create a requestKey, set record/playback/forward flags, etc.
Endpoint key google: matches the first path part after /proxy: Incoming URL http://localhost:8989/proxy/google/something selects endpoint google The remaining path /something is added to targetBaseUrl -> https://www.google.com/com/something
Endpoint key /googly/ding: matches the exact path after /proxy: Incoming URL http://localhost:8989/proxy/googly/ding/dong selects endpoint '/googly/ding' The remaining path /dong is added to targetBaseUrl Endpoint matching gives priority to the most specific definition. Currently this is based on the length of the key. This impacts endpoint maching as follows: Incoming URL http://localhost:8989/proxy/googly/ding/dazzle/doo selects endpoint '/googly/ding/dazzle' (instead of '/googly/ding') The remaining path /doo is added to targetBaseUrl
Endpoint key /googly/:param/ding dynamically matches the :param with any path value not containing a slash: Incoming URL http://localhost:8989/proxy/googly/some-path-value/ding/doo selects endpoint /googly/:param/ding The remaining path /doo is added to targetBaseUrl The param can be used in the targetBaseUrl Multiple params may be defined, names must be unique
Using a default: a key of _default will match any request that was not matched by any of the other endpoint definitions: Incoming URL http://localhost:8989/proxy/goggle/ding selects endpoint '_default' The full path /goggle/ding is added to targetBaseUrl
The /googly/ding endpoint does not forward as it overrides the global forward setting
The _default endpoint does not record as it overrides the global record setting
cacheConglomerate
cacheQueue
The cacheConglomerate can hold a list of caches and will continue responding to your requests with the cache that matches a calculated request key.
It cannot contain duplicate request keys.
Additional requests will serve the same cache.
As request keys are unique, the order of the caches does not matter.
The cacheConglomerate will not run out of caches as caches are not removed from the list.
GET:/http-api/plugins/cacheConglomerate/caches Retrieve the current list of stored caches
DELETE:/http-api/plugins/cacheConglomerate/caches Empty the current list of stored caches
POST:/http-api/plugins/cacheConglomerate/caches Add provided list of caches to the current list of stored caches
PUT:/http-api/plugins/cacheConglomerate/caches Replace the current list of stored caches with provided list
GET:/http-api/plugins/cacheConglomerate/recorded-caches Get the current list of recorded caches
The cacheQueue can hold a list of caches and serves them in order.
After a cache is served it is removed from the list and will not be served again.
It can contain duplicate request keys. Additional requests will serve the next cache that matches the request key.
The order of the caches determines the order in which they are served: it will serve the first cache that matches the request key.
The cacheQueue can run out of caches to serve.
GET:/http-api/plugins/cacheQueue/caches Retrieve the current list of stored caches
DELETE:/http-api/plugins/cacheQueue/caches Empty the current list of stored caches
PUT:/http-api/plugins/cacheQueue/caches Replace the current list of stored caches with provided list
GET:/http-api/plugins/cacheQueue/recorded-caches Get the current list of recorded caches