Getting started

It only takes a few steps to get your mock server up and running !

System Requirements

Node.js and npm (stable) only
- (Optional) Without them, natively built executable is also available

If not installed yet:

npm install -D apimock-rs

Note that the package name is apimock-rs (ends with -rs) and its command name below is apimock.

Nothing. Just JSON and go !

npx apimock

Besides, if you use natively built executable, run ./apimock instead.

From another terminal (as web client), access the server:

curl -i http://localhost:3001/

Expected response: HTTP Status Code 404 (NOT FOUND)

This is correct, as no .json file exists on the server yet. Now, let's prepare for the next test. In the server terminal, run:

echo '{"hello": "world"}' > greetings.json

npx apimock

Then, access it again with:

curl http://localhost:3000/greetings

Expected response:

{
  "hello": "world"
}

All set 😺 ?