360-mock-server 1.1.1 → 1.2.0

package/README.md

@@ -3,11 +3,14 @@
 **360 Mock Server** is a zero-configuration mock REST API designed for frontend developers.
 It allows you to instantly create and manage RESTful APIs **without building a backend**, making it ideal for frontend development, testing, demos, and rapid prototyping.
 
+Now with **Faker.js integration** for automatic fake data generation!
+
 
 ## ✨ Why 360 Mock Server?
 
 * No backend setup required
 * Works instantly with **any endpoint**
+* **Auto-generate fake data** with Faker.js
 * Interactive CLI + REST API
 * Persistent JSON-based storage
 * Ideal for React, React Native, Vue, Angular, Redux apps
@@ -101,6 +104,54 @@ Content-Type: application/json
 ```
 
 
+## 🎲 Auto-Generate Fake Data with Faker.js
+
+Generate realistic fake data instantly! Just send a POST request with `fields` array:
+
+### Generate 10 Users (default count)
+
+```bash
+POST /users
+{
+  "fields": ["name", "email", "avatar", "phone"]
+}
+```
+
+### Generate 50 Products with custom count
+
+```bash
+POST /products
+{
+  "fields": ["productName", "price", "category", "description", "image"],
+  "count": 50
+}
+```
+
+### Available Faker Fields
+
+| Category    | Fields                                                                 |
+| ----------- | ---------------------------------------------------------------------- |
+| **Person**  | `name`, `firstName`, `lastName`, `username`, `email`, `phone`, `avatar`, `bio`, `jobTitle`, `gender` |
+| **Location**| `address`, `city`, `state`, `country`, `zipCode`, `latitude`, `longitude` |
+| **Company** | `company`, `companyName`, `department`                                 |
+| **Internet**| `website`, `url`, `ip`, `password`                                     |
+| **Content** | `title`, `description`, `body`, `text`, `sentence`, `paragraph`, `slug`|
+| **Commerce**| `price`, `product`, `productName`, `productDescription`, `category`    |
+| **Images**  | `image`, `imageUrl`                                                    |
+| **Dates**   | `date`, `pastDate`, `futureDate`, `birthDate`                          |
+| **Numbers** | `number`, `age`, `rating`, `quantity`                                  |
+| **Boolean** | `boolean`, `isActive`, `isVerified`                                    |
+| **Misc**    | `uuid`, `color`, `word`, `words`                                       |
+
+### Get All Available Fields
+
+```bash
+GET /faker/fields
+```
+
+> **Note:** If your POST body contains a `fields` array, it generates fake data. Otherwise, it creates a single item with your provided key-value pairs.
+
+
 ## 🔌 Frontend Integration Examples
 
 <details open>
@@ -191,6 +242,7 @@ npx 360-mock-server --file db.json
 * ✅ Zero-config setup
 * ✅ Supports **any REST endpoint**
 * ✅ Full CRUD operations
+* ✅ **Auto-generate fake data** with Faker.js
 * ✅ Auto-generated unique IDs
 * ✅ Automatic timestamps (`createdAt`, `updatedAt`)
 * ✅ Persistent JSON storage

package/lib/server.js

@@ -2,6 +2,7 @@ const express = require("express");
 const fs = require("fs");
 const path = require("path");
 const cors = require("cors");
+const { faker } = require("@faker-js/faker");
 
 const app = express();
 const PORT = process.env.PORT || 3000;
@@ -46,6 +47,99 @@ app.use((req, res, next) => {
   next();
 });
 
+// Faker field mappings for automatic data generation
+const fakerFieldMap = {
+  // Person
+  name: () => faker.person.fullName(),
+  firstName: () => faker.person.firstName(),
+  lastName: () => faker.person.lastName(),
+  username: () => faker.internet.username(),
+  email: () => faker.internet.email(),
+  phone: () => faker.phone.number(),
+  avatar: () => faker.image.avatar(),
+  bio: () => faker.person.bio(),
+  jobTitle: () => faker.person.jobTitle(),
+  gender: () => faker.person.sex(),
+  
+  // Location
+  address: () => faker.location.streetAddress(),
+  city: () => faker.location.city(),
+  state: () => faker.location.state(),
+  country: () => faker.location.country(),
+  zipCode: () => faker.location.zipCode(),
+  latitude: () => faker.location.latitude(),
+  longitude: () => faker.location.longitude(),
+  
+  // Company
+  company: () => faker.company.name(),
+  companyName: () => faker.company.name(),
+  department: () => faker.commerce.department(),
+  
+  // Internet
+  website: () => faker.internet.url(),
+  url: () => faker.internet.url(),
+  ip: () => faker.internet.ip(),
+  password: () => faker.internet.password(),
+  
+  // Content
+  title: () => faker.lorem.sentence(),
+  description: () => faker.lorem.paragraph(),
+  body: () => faker.lorem.paragraphs(3),
+  text: () => faker.lorem.text(),
+  sentence: () => faker.lorem.sentence(),
+  paragraph: () => faker.lorem.paragraph(),
+  slug: () => faker.lorem.slug(),
+  
+  // Commerce
+  price: () => parseFloat(faker.commerce.price()),
+  product: () => faker.commerce.productName(),
+  productName: () => faker.commerce.productName(),
+  productDescription: () => faker.commerce.productDescription(),
+  category: () => faker.commerce.department(),
+  
+  // Images
+  image: () => faker.image.url(),
+  imageUrl: () => faker.image.url(),
+  
+  // Date/Time
+  date: () => faker.date.recent().toISOString(),
+  pastDate: () => faker.date.past().toISOString(),
+  futureDate: () => faker.date.future().toISOString(),
+  birthDate: () => faker.date.birthdate().toISOString(),
+  
+  // Numbers
+  number: () => faker.number.int({ min: 1, max: 1000 }),
+  age: () => faker.number.int({ min: 18, max: 80 }),
+  rating: () => faker.number.int({ min: 1, max: 5 }),
+  quantity: () => faker.number.int({ min: 1, max: 100 }),
+  
+  // Boolean
+  boolean: () => faker.datatype.boolean(),
+  isActive: () => faker.datatype.boolean(),
+  isVerified: () => faker.datatype.boolean(),
+  
+  // Misc
+  uuid: () => faker.string.uuid(),
+  color: () => faker.color.human(),
+  word: () => faker.word.noun(),
+  words: () => faker.word.words(3),
+};
+
+// Get available faker fields
+app.get("/faker/fields", (req, res) => {
+  res.json({
+    message: "Available faker fields for auto-generation",
+    fields: Object.keys(fakerFieldMap),
+    usage: {
+      endpoint: "POST /:resource",
+      example: {
+        fields: ["name", "email", "avatar"],
+        count: 20
+      }
+    }
+  });
+});
+
 app.get("/", (req, res) => {
   const data = readData();
   const resources = Object.keys(data).filter(k => !k.startsWith("_"));
@@ -56,10 +150,11 @@ app.get("/", (req, res) => {
     endpoints: {
       "GET /:resource": "Get all items",
       "GET /:resource/:id": "Get single item",
-      "POST /:resource": "Create new item",
+      "POST /:resource": "Create new item OR generate fake data with { fields: [...], count: N }",
       "PUT /:resource/:id": "Replace item",
       "PATCH /:resource/:id": "Update item",
-      "DELETE /:resource/:id": "Delete item"
+      "DELETE /:resource/:id": "Delete item",
+      "GET /faker/fields": "List available faker fields"
     }
   });
 });
@@ -127,6 +222,43 @@ app.post("/:resource", (req, res) => {
     data[resource] = [];
     console.log(`           📁 Created new resource: ${resource}`);
   }
+  
+  // Check if this is a faker request (has 'fields' array)
+  if (Array.isArray(req.body.fields) && req.body.fields.length > 0) {
+    const { fields, count = 10 } = req.body;
+    
+    const generatedItems = [];
+    for (let i = 0; i < count; i++) {
+      const item = { 
+        id: faker.string.uuid(), 
+        createdAt: new Date().toISOString() 
+      };
+      
+      fields.forEach(field => {
+        if (fakerFieldMap[field]) {
+          item[field] = fakerFieldMap[field]();
+        } else {
+          // Default to random words if field not mapped
+          item[field] = faker.word.words(2);
+        }
+      });
+      
+      data[resource].push(item);
+      generatedItems.push(item);
+    }
+    
+    writeData(data);
+    console.log(`           ✅ Generated ${count} fake ${resource}`);
+    
+    return res.status(201).json({ 
+      message: `Successfully generated ${count} ${resource}`,
+      count: count,
+      sample: generatedItems.slice(0, 3),
+      total: data[resource].length
+    });
+  }
+  
+  // Normal POST - create single item with provided key-value pairs
   const newId = req.body.id || Date.now();
   if (data[resource].some(item => String(item.id) === String(newId))) {
     return res.status(409).json({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "360-mock-server",
-  "version": "1.1.1",
-  "description": "🚀 Zero-config dynamic mock REST API server for frontend developers",
+  "version": "1.2.0",
+  "description": "🚀 Zero-config dynamic mock REST API server with Faker.js auto-generation for frontend developers",
   "main": "lib/server.js",
   "bin": {
     "360-mock": "./bin/cli.js"
@@ -17,11 +17,13 @@
     "server",
     "json",
     "fake",
+    "faker",
     "backend",
     "frontend",
     "development",
     "testing",
-    "crud"
+    "crud",
+    "auto-generate"
   ],
   "author": "zahidrahimoon",
   "license": "MIT",
@@ -42,6 +44,7 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
+    "@faker-js/faker": "^10.2.0",
     "commander": "^11.1.0",
     "cors": "^2.8.5",
     "express": "^4.18.2"