availity-ekko
Version:
Mock server simulating Availity API rest services
434 lines (378 loc) • 11.2 kB
Markdown
> Mock server simulating Availity API rest services
[](http://opensource.org/licenses/MIT)
[](https://npmjs.org/package/availity-ekko)
[](https://david-dm.org/Availity/availity-ekko)
[](https://travis-ci.org/Availity/availity-ekko)
[](https://ci.appveyor.com/project/robmcguinness/availity-ekko)
* [Intro](
* [Server Configuration](
* [Route Configuration](
* [Proxy Configuration](
* [Contributing](
* [Authors](
* [Disclaimer](
* [License](
Develop web applications without heavy back-end services by running a simple Express http server which can deliver mock responses.
Responses can be JSON or other formats to simulate REST services. Access-Control HTTP Headers are set by default to allow CORS requests. Mock services are configured in the [routes.json](./routes.json) file.
>
This server can return other file types besides XML or JSON (PDFs, images, etc). The appropriate response headers will be automatically set for different file types. For a complete list of file types supported view the [mime types here](https://github.com/jshttp/mime-db/blob/88d8b0424d93aefef4ef300dc35ad2c8d1e1f9d4/db.json).
## Server Configuration
The default server configuration can be found in [config.js](./config.js). Pass a different configuration file to the Ekko server to override the defaults.
>
```js
var path = require('path');
var Ekko = require('availity-ekko');
var configPath = path.join(__dirname, 'path/to/config.js');
var ekko = new Ekko(configPath);
ekko.start();
```
Ekko also supports overriding defaults using command line arguments (useful to setup different configurations in WebStorm). The CLI commands are equivalent to the `config.js` object using dot notation. Using example configuration below, run `node index.js --severs.web.port=8888` to override the web server port for `development` mode.
>
```javascript
{
development: {
...
servers: {
web: {
host: "0.0.0.0",
port: 9999 // --severs.web.port=8888
}
}
...
}
}
```
The `routes.json` defines the mock responses for rest services. Below are some sample scenarios that should help you understand the configuration options.
The mock configuration supports deep nested introspection of JSON and multi-part form data when matching routes. See [Example 6](
>
```javascript
"v1/route1": {
"file": "example1.json" // match for GET|PUT|POST|DELETE
}
```
>
```javascript
"v1/route2": {
"latency": 250, // latency in (ms)
"file": "example2.json", // match for all GET|PUT|POST|DELETE requests
"status": 201 // return status code 201
}
```
>
```javascript
"v1/route3": {
"file": "example3.json", // match for GET|PUT|DELETE requests
"post": "example1.json" // match for POST requests
}
```
>
```javascript
"v1/route4": {
"get": "example1.json", // match for all GET requests
"put": "example2.json", // match for all PUT requests
"post": "example3.json", // match for all POST requests
"delete": "example4.json" // match for all DELETE requests
}
```
>
```javascript
"v1/route5": {
"file": "example1.json", // match for all POST|PUT|DELETE requests
"get": [
{
"file": "example2.json",
"status": 200, // default status code is 200
"params": { // match for GET /v1/router?a=1&b=2&c=3
"a": "1",
"b": "2",
"c": "3"
}
},
{
"file": "example3.json",
"params": { // match for GET /v1/router?a=1&a=2&a=3&a=4
"a": [1, 2, 3, 4]
}
}
]
}
```
>
```javascript
"v1/route6": {
"file": "example1.json", // match for all GET|PUT|DELETE requests
"post": [
{
"file": "example2.json",
"params": { // match for POST with JSON payload {"a": 1}
"a": 1
}
},
{
"file": "example3.json",
"params": { // match for POST with JSON payload {a: {b: {c: "1"} } }
"a.b.c": 1 // config allows for nested attributes
}
},
{
"file": "example4.json",
"params": { // match for POST with JSON payload {a : {b: [0,1,2] } }
"a.b[2]": 2 // config allows for nested array attributes
}
}
]
},
```
>
```html
<form action="/api/v1/users" method="post" enctype="multipart/form-data">
<p><input type="text" name="a" value="example">
<p><input type="file" name="b"> <!--the name of the file is used below to match and score the proper response -->
<p><button type="submit">Submit</button>
</form>
```
>
```javascript
"v1/route7": {
"file": "example1.json", // match for all GET|PUT|DELETE requests
"post": [
{
"file": "example2.json" // default response if none match below
},
{
"file": "example3.json",
"params": { // match for form submit where form fields a=1 and b="sample.pdf"
"a": 1,
"b": "sample.pdf"
}
},
{
"file": "example4.json",
"params": { // match for form submit where form fields a=2 and b="another.name.jpg"
"a": 2,
"b": "another.name.jpg"
}
}
]
}
```
>
```javascript
"v1/route8": {
"file": "example1.json",
"get": [
{
"file": "example1.json",
"response": [
{
// match for first GET request to /v1/route8
"status": 202,
"file": "example1.json"
},
{
// match for second GET request to /v1/route8
"status": 201,
"file": "example2.json"
}
]
}
]
}
```
>
```javascript
"v1/route10": {
"get": [
{
"file": "example1.json",
"response": [
{
"status": 202,
"file": "example1.json",
"repeat": 3
},
{
"status": 202,
"file": "example2.json"
},
{
"status": 202,
"file": "example3.json",
"repeat": 4
},
{
"status": 201,
"file": "example4.json"
}
]
}
]
}
```
>
```javascript
"v1/route9": {
"url": "http://www.google.com"
}
```
You define Ekko server configurations in `config.json`. Each configuration requires a `host`. Other configuration options are outlined below. You must have a configuration called `web` that is used to serve static files and the proxy server. An example configuration looks like this:
>
```javascript
{
user: 'johndoe', // global set `RemoteUser` header across all proxy requests
servers: {
web: { // (required) server used for static resources
host: "0.0.0.0",
port: 9999
}
}
}
```
If you omit the port, or set it to `0`, Ekko will let the OS assign a random open port.
This allows you to run multiple servers without keeping track of all ports being used. (see Example 2)
>
```javascript
servers: {
web: {
host: "0.0.0.0",
port: 0 // dynamic port
}
}
```
>
```javascript
servers: {
web: {
host: "127.0.0.1",
port: 9999
},
api: {
host: "127.0.0.1",
port: 7777, // port number to proxied server
proxy: true, // defaults to false. when true the proxy is enabled
headers: {
"userid": "johndoe" // set custom header for proxy requests to this server
},
proxies:
[
{
context: "/api", // if url context matches the proxy is triggered for all routes
rewrite: { // (optional) allows url to be rewritten before forwarding request to a proxied server
from: "^/api", // convert /api/v1/ping
to: "" // to /v1/ping
}
}
]
}
}
```
>
```javascript
servers: {
web: {
host: "127.0.0.1",
port: 9999
},
api: {
host: "127.0.0.1",
port: 7777,
proxy: true,
proxies:
[
{
context: "/api",
rewrite: {
from: "^/api",
to: ""
},
headers: {
"userid": "johndoe" // set custom header for proxy requests this context for this server
}
},
{
context: "/api2", // you can define multiple context's for a proxied server
rewrite: {
from: "^/api2",
to: "/v1"
}
}
]
}
}
```
>
```javascript
servers: {
web: {
host: "127.0.0.1",
port: 9999
},
api: {
host: "127.0.0.1",
port: 7777,
proxy: true,
proxies:
[
{
context: "/api",
rewrite: {
from: "^/api",
to: ""
}
}
]
},
other: { // define more servers to proxy
host: "127.0.0.1",
port: 8888,
proxy: true,
proxies:
[
{
context: "/test",
rewrite: {
from: "^/test",
to: ""
}
}
]
}
}
```
1. `git clone https://github.com/Availity/availity-ekko`
1. `git checkout develop`
1. `git pull upstream develop`
1. `git checkout -b feature/branch-name`
1. Create some awesome code or fabulous bug fixes
1. Open a [pull request](https://help.github.com/articles/using-pull-requests/) against the develop branch
1. Wait for a commiter to merge and release
**Robert McGuinness**
+ [rob.mcguinness@availity.com](rob.mcguinness@availity.com)
**Kasey Powers**
+ [kasey.powers@availity.com](kasey.powers@availity.com)
Open source software components distributed or made available in the Availity Materials are licensed to Company under the terms of the applicable open source license agreements, which may be found in text files included in the Availity Materials.
Copyright (c) 2015 Availity, LLC