API Mock Generator

Generate realistic mock data for APIs from schema definitions.

Installation

npm install api-mock-generator

Usage

import { fullName, email, uuid, generate, generateMany } from 'api-mock-generator';

API

Identity

uuid()          // 'a1b2c3d4-e5f6-4g7h-8i9j-k0l1m2n3o4p5'
firstName()     // 'John'
lastName()      // 'Smith'
fullName()      // 'John Smith'
username()      // 'cool_john123'
password(12)    // 'Kj#8mP$2qL@9'

Contact

email()              // '[email protected]'
email('Jane Doe')    // '[email protected]'
phone()              // '(555) 123-4567'
phone('###-###-####') // '555-123-4567'

Address

address()       // { street, city, country, zipCode }
streetAddress() // '1234 Main St'
city()          // 'New York'
country()       // 'United States'
zipCode()       // '12345'

Company

company()  // 'Acme Corp'

Dates

date()                    // Random date
date({ from, to })        // Date in range
pastDate(2)               // Within last 2 years
futureDate(1)             // Within next year

Numbers

integer(1, 100)           // 42
float(0, 10, 2)           // 3.14
boolean()                 // true or false
boolean(0.8)              // 80% chance true

Text

lorem(10)       // 10 words of lorem ipsum
paragraph(3)    // 3 sentences

Web

url()                    // 'https://example.com/about'
imageUrl(400, 300)       // Placeholder image URL
avatarUrl('John')        // Avatar URL
color()                  // '#ff5733'
ipAddress()              // '192.168.1.100'
creditCard()             // '4111111111111111'

Utilities

pick(['a', 'b', 'c'])         // Random element
pickMultiple(['a','b','c'], 2) // N random elements

Schema Generation

// Generate single object from schema
const user = generate({
  id: uuid,
  name: fullName,
  email: email,
  age: () => integer(18, 65)
});

// Generate array of objects
const users = generateMany({
  id: uuid,
  name: fullName
}, 100);

License

MIT