Package Exports

dynamock

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dynamock) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

⚠️ NOT PRODUCTION READY ⚠️

dynamock

Install

yarn add dynamock
# or NPM
npm install dynamock

Usage

WIP

Properties matching

WIP

Api

Configuration

Using the configuration is optional. However it gives the ability of reusing redundant data across requests and simplifying fixtures setup.

/___config - Retrieve configuration

Responses

Status 200 - OK

{
  "headers": "{object} - Dictionary of headers (object) by name (string)",
  "query": "{object} - Dictionary of query (object) by name (string)",
  "cookies": "{object} - Dictionary of cookies (object) by name (string)"
}

Example:

{
  "headers": {},
  "query": {},
  "cookies": {}
}

/___config - Update configuration

Request

Body

{
  "headers": "{object} [default={}] - Dictionary of headers (object) by name (string)",
  "query": "{object} [default={}] - Dictionary of query (object) by name (string)",
  "cookies": "{object} [default={}] - Dictionary of cookies (object) by name (string)"
}

Example:

{
  "headers": {
    "apiBearer": {
      "Authorization": "Bearer xyz"
    }
  }
}

Responses

Status 200 - OK

{
  "headers": "{object}",
  "query": "{object}",
  "cookies": "{object}"
}

Example:

{
  "headers": {
    "captcha": {
      "X-CAPTCHA-TOKEN": "fake"
    },
    "cors": {
      "Access-Control-Allow-Origin": "*",
      "Access-Control-Allow-Methods": "*",
      "Access-Control-Allow-Headers": "*"
    }
  },
  "query": {
    "campaign": {
      "utm_source": "x",
      "utm_campaign": "y"
    }
  },
  "cookies": {
    "anonymousUser": {
      "PHPSESSID": "x"
    },
    "loggedInUser": {
      "PHPSESSID": "y"
    }
  }
}

Status 400 - BAD REQUEST

Wrong configuration format

/___config - Reset configuration

Responses

Status 204 - NO CONTENT

Fixtures

The fixtures are composed of:

request data to match the incoming requests
response data when a match occurred

/___fixtures - Add fixture

Request

Body

{
  "request": {
    "path": "{string} - Http path to match requests, use wildcard '*' to match all",
    "method": "{string} - Http method to match requests, case insensitive, use wildcard '*' to match all",
    "headers": "{object} [default={}] - Headers to match requests",
    "query": "{object} [default={}] - Query to match requests",
    "cookies": "{object} [default={}] - Cookies to match requests",
    "body": "{object} [default=``] - Body to match requests",
    "options": {
      "headers": {
        "strict": "{boolean} [default=false] - Strictly match headers"
      },
      "cookies": {
        "strict": "{boolean} [default=false] - Strictly match cookies"
      },
      "query": {
        "strict": "{boolean} [default=false] - Strictly match query"
      },
      "body": {
        "strict": "{boolean} [default=false] - Strictly match body"
      }
    }
  },
  "response": {
    "status": "{number} [default=200] - Response status code",
    "headers": "{object} [default={}] - Response headers",
    "cookies": "{object} [default={}] - Response cookies",
    "body": "{string|object|array} [default=``] - Body to match requests",
    "filepath": "{string} [default=``] - Filepath to serve with auto mime-types",
    "options": {
      "delay": "{number} [default=0] - Delay the response with a number of milliseconds"
    }
  }
}

Examples:

{
  "request": {
    "path": "/pandas",
    "method": "get"
  },
  "response": {
    "body": [{ "id": "1" }, { "id": "2" }]
  }
}

{
  "request": {
    "path": "/cdn/images/fennec.jpg",
    "method": "get"
  },
  "response": {
    "filepath": "/absolute/path/tofennec.jpg",
    "delay": 1000
  }
}

{
  "request": {
    "path": "/heros",
    "method": "POST",
    "body": {
      "name": "po",
      "type": "panda"
    }
  },
  "response": {
    "body": {
      "id": "1",
      "name": "po",
      "type": "panda"
    }
  },
  "options": {
    "request": {
      "body": {
        "strict": true
      }
    }
  }
}

{
  "request": {
    "path": "*",
    "method": "OPTIONS"
  },
  "response": {
    "headers": {
      "Access-Control-Allow-Origin": "*",
      "Access-Control-Allow-Methods": "*",
      "Access-Control-Allow-Headers": "*"
    },
    "body": ""
  }
}

Responses

Status 200 - OK

{
  "id": "{string}"
}

Example:

{
  "id": "38ed32e9fb0a1e5c7cb1b6f0ff43f6060d8b4508"
}

Status 400 - BAD REQUEST

Path or method are not provided

${PROPERTY} group named "${VALUE}" is not in the configuration

${PROPERTY} "${VALUE}" should be an object or a configuration header group name.

${PROPERTY} should be an array or an object

Status 409 - CONFLICT

Route {METHOD} ${PATH} is already registered.

/___fixtures/bulk - Bulk add fixtures

It is meant to setup multiple fixtures at once.

Request

Body

[
  {
    "request": {
      "path": "{string} - Http path to match requests, use wildcard '*' to match all",
      "method": "{string} - Http method to match requests, case insensitive, use wildcard '*' to match all",
      "headers": "{object} [default={}] - Headers to match requests",
      "query": "{object} [default={}] - Query to match requests",
      "cookies": "{object} [default={}] - Cookies to match requests",
      "body": "{object} [default=``] - Body to match requests",
      "options": {
        "headers": {
          "strict": "{boolean} [default=false] - Strictly match headers"
        },
        "cookies": {
          "strict": "{boolean} [default=false] - Strictly match cookies"
        },
        "query": {
          "strict": "{boolean} [default=false] - Strictly match query"
        },
        "body": {
          "strict": "{boolean} [default=false] - Strictly match body"
        }
      }
    },
    "response": {
      "status": "{number} [default=200] - Response status code",
      "headers": "{object} [default={}] - Response headers",
      "cookies": "{object} [default={}] - Response cookies",
      "body": "{string|object|array} [default=``] - Body to match requests",
      "filepath": "{string} [default=``] - Filepath to serve with auto mime-types",
      "options": {
        "delay": "{number} [default=0] - Delay the response with a number of milliseconds"
      }
    }
  }
]

Examples:

[
  {
    "request": {
      "path": "/pandas",
      "method": "get"
    },
    "response": {
      "body": [{ "id": "1" }, { "id": "2" }]
    }
  },
  {
    "request": {
      "path": "/cdn/images/fennec.jpg",
      "method": "get"
    },
    "response": {
      "filepath": "/absolute/path/tofennec.jpg"
    }
  }
]

Status 200 - OK

[
  {
    "id": "{string}"
  }
]

Example:

[
  {
    "id": "38ed32e9fb0a1e5c7cb1b6f0ff43f6060d8b4508"
  },
  {
    "id": "086c67ef89fd832deeae33b209e6e8ecc6b32003"
  }
]

Status 400 - BAD REQUEST

The fixture is not valid

Status 409 - CONFLICT

Another fixture with the same matcher is already registered

/___fixtures/:id - Delete a fixture

Request

Params

{
  "id": "{string}"
}

Example:

    DELETE /___fixtures/_38ed32e9fb0a1e5c7cb1b6f0ff43f6060d8b4508

Responses

Status 204 - NO CONTENT

/___fixtures - Delete all fixtures

Responses

Status 204 - NO CONTENT