MockServer Start

MockServer can be started in test code or as a standalone process.

Start From Code

import { MockServer } from '@toolstackhq/mockit';

const server = new MockServer({ port: 3001 });
await server.start();

console.log(server.address); // http://127.0.0.1:3001

Your app must call the mock server address.

const res = await fetch('http://127.0.0.1:3001/api/users');

Start Standalone From CLI

npx @toolstackhq/mockit serve --config ./mockit.config.ts --swagger ./openapi.yaml --port 3001 --host 127.0.0.1

This starts the same MockServer runtime as a standalone process.

First-Time Setup

If you are creating a TypeScript mock config for the first time, generate one:

npx @toolstackhq/mockit init

In a terminal, init will ask whether you want:

• the default starter config
• a guided setup that asks for endpoint path, method, status, and JSON response body

The generated file is:

./mockit.config.ts

Then start it with:

npx @toolstackhq/mockit serve --config ./mockit.config.ts --port 3001

Dashboard:

http://127.0.0.1:3001/_mockit

Admin APIs:

• http://127.0.0.1:3001/_mockit/api/mocks
• http://127.0.0.1:3001/_mockit/api/requests
• http://127.0.0.1:3001/_mockit/api/unmatched
• http://127.0.0.1:3001/_mockit/api/pending
• http://127.0.0.1:3001/_mockit/api/history

Update A Running Standalone Mock

If the standalone mock is already running, tests can update it with RemoteMockServer:

import { RemoteMockServer } from '@toolstackhq/mockit';

const remote = new RemoteMockServer('http://127.0.0.1:3001');

await remote.expect('/api/login')
  .method('POST')
  .count(1)
  .returns(403)
  .withBody({ message: 'unauthorized' })
  .apply();

Why Use Standalone

• keep the mock running with the app during local development
• let Playwright or Cypress hit a real mock server
• let tests override behavior without starting the server themselves
• give QA or manual testers a stable fake backend even outside automated tests

npm Script

If a project installs @toolstackhq/mockit, it can expose the CLI through an npm script:

{
  "scripts": {
    "mockit": "mockit serve --config ./mockit.config.ts --port 3001"
  }
}

Then run:

npm run mockit