Installation

Installation

Get MockMaster installed and ready to use in your project.

Install All Packages

For full functionality, install all MockMaster packages:

npm install @mockmaster/core @mockmaster/data @mockmaster/openapi @mockmaster/msw-adapter @mockmaster/cli

Install Individual Packages

You can also install packages individually based on your needs:

Core Package

Required for basic path matching and HTTP routing.

npm install @mockmaster/core

Key Features:

  • Path matching with parameters (e.g., /users/:id)
  • Wildcard matching (e.g., /api/*)
  • Parameter extraction
  • HTTP routing utilities

Data Package

Factories and Faker.js integration for generating realistic test data.

npm install @mockmaster/data

Key Features:

  • Factory system for building test data
  • Full Faker.js integration
  • Sequence generation
  • Customizable overrides

OpenAPI Package

Parse OpenAPI 3.0 specs and generate mocks automatically.

npm install @mockmaster/openapi

Key Features:

  • Parse JSON and YAML OpenAPI specs
  • Generate mock data from schemas
  • Extract operations from specs
  • Support for complex schemas

MSW Adapter

Record and replay API responses.

npm install @mockmaster/msw-adapter

Key Features:

  • Create scenarios and recordings
  • Replay handler creation
  • Request matching
  • Response generation

CLI Package

File system operations for reading/writing scenarios.

npm install @mockmaster/cli

Key Features:

  • Read/write scenarios to disk
  • Generate scenarios from OpenAPI specs
  • File system utilities
  • Scenario management

Prerequisites

Before installing MockMaster, ensure you have:

  • Node.js 18+ or 20+
  • TypeScript 5.3+ (recommended)
  • A test framework (Vitest, Jest, Playwright, etc.)

Verify Installation

After installation, verify everything is working:

import { matchPath } from '@mockmaster/core'
import { defineFactory, build, fake } from '@mockmaster/data'
import { parseSpec } from '@mockmaster/openapi'
import { createScenario } from '@mockmaster/msw-adapter'
import { writeScenario } from '@mockmaster/cli'
 
console.log('MockMaster installed successfully!')

Next Steps

Now that you have MockMaster installed:

  1. Follow the Quick Start guide to create your first scenario
  2. Learn about Core Concepts to understand how MockMaster works
  3. Explore the API Packages documentation for detailed API references

Troubleshooting

TypeScript Errors

If you encounter TypeScript errors, ensure you’re using TypeScript 5.3 or higher:

npm install -D typescript@latest

Module Resolution

If imports are not resolving, check your tsconfig.json:

{
  "compilerOptions": {
    "moduleResolution": "node",
    "esModuleInterop": true,
    "resolveJsonModule": true
  }
}

Peer Dependencies

Some packages may require peer dependencies. Install them as needed:

npm install msw
OverviewQuick Start