MockServer Configure

TypeScript defaults:

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

export default defineConfig([
  {
    path: '/api/users',
    method: 'GET',
    response: {
      status: 200,
      body: [{ id: 1, name: 'Default User' }],
    },
  },
]);

await server.loadDefaults('./mock-config.ts');

First-time setup:

npx @toolstackhq/mockit init

init can write the default starter file or guide you through a few questions to generate your first endpoints.

Guided setup asks for:

• endpoint path
• HTTP method
• response status
• response body JSON
• optional response headers JSON

It still writes a normal mockit.config.ts, so you can keep editing it by hand afterward.

OpenAPI:

await server.loadSwagger('./openapi.yaml');

Swagger Response Data

When MockIt builds a response from Swagger or OpenAPI, it tries to return realistic schema-valid data instead of empty placeholders.

Generation order:

• use example values when they exist
• use enum first values when they exist
• use format-aware defaults like email, uuid, date, and uri
• use property-aware fallback strings like:
  • name -> Sample Name
  • tag -> default-tag
  • status -> active
  • currency -> USD

Example:

properties:
  id:
    type: integer
    example: 1
  name:
    type: string
    example: Buddy
  tag:
    type: string

Generated response:

{
  "id": 1,
  "name": "Buddy",
  "tag": "default-tag"
}

So yes, Swagger mocks are intended to return usable sample data, not just blank bodies.

CLI:

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