Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
responses
README.md
app.js
package.json
yarn.lock

README.md

amokjs - simple backend mocking framework

amokjs helps you build backend service mocks. It allows you to simply serve http responses from files. Supports multiple response codes, headers and dynamically generated values. Seen the example applications.

Since version 2.x.x amokjs supports custom plugins. We welcome community submissions!

how it works?

By default, amokjs serves responses from flat files in the responses directory in project root. It supports JSON, XML, SOAP and other formats. You can just add a new resource file into resources derectory and amokjs will serve it as response.

how to run?

This example app implements simple amokjs mock served from responses directory.

yarn
node app.js

amokjs will serve response content from a file in the responses directory on port 3030. There are 2 ways of requesting mocked backend responses from API powered by amok:

  • amokjs will serve response content from a file matching file name in the request path. For example if you send API request to yourapi.com/mock-api/xml mock will serve response from file named xml.

  • amokjs will serve response content from a file matching x-mock-filename header content. In this case the main request path has to be /. For example if you send API request to yourapi.com/mock-api/ and request will contain x-mock-filename HTTP header - mock will serve response from file named xml.

supported headers

Headers amokjs supports:

  • x-mock-response-code request header allows developers to request custom HTTP response code from mock API
  • x-mock-filename request header allows developers to pass mock file name in the HTTP request header rather then request path. For example if x-mock-filename: xml is used in the header and request path is / mock API will attempt to serve response from xml file.

supported template variables

In your response files you can use several template variables in order to get values generated dynamically. Below are the template values amockjs supports:

  • @date@ - will be replaced with the current timestamp. Format: YYYY-MM-DD
  • @randomDate@ - will be replaced with the random timestamp. Format: YYYY-MM-DD
  • @longid@ - will be replaced with the 10 digits long random number
  • @shortid@ - will be replaced with the random number up to 5 digits long

example curl requests

Below are few example curl requests to test the mock API:

curl -XGET 'http://localhost:3030/xml'
curl -XGET -H 'x-mock-filename: xml' 'http://localhost:3030/'
curl -XGET -H "x-mock-response-code: 500" 'http://localhost:3030/xml'