view-api 1.0.1

package/README.md

@@ -0,0 +1,58 @@
+# view-api
+
+A lightweight CLI tool to run mock APIs locally from a JSON configuration file.
+
+Perfect for frontend development, testing, and prototyping without a real backend.
+
+## ✨ Features
+
+- Run mock APIs from a single JSON file
+- Customizable port
+- Randomized success / error responses
+- Zero setup for frontend teams
+- Works fully offline
+
+## 📦 Installation
+
+You don’t need to install it globally.
+
+Run directly with `npx`:
+
+```bash
+npx watch-api start ./mock.json --port 4000
+```
+
+## 📖 Mock Config Format
+
+You gotta use this json structure in able to use the api
+
+```json
+{
+  "version": "1.0",
+  "routes": {
+    "GET /products": {
+      "behavior": {
+        "successRate": 70
+      },
+      "responses": {
+        "success": {
+          "statusCode": 200,
+          "body": {
+            "status": "success",
+            "data": [{ "id": 1, "name": "Product A" }]
+          }
+        },
+        "errors": [
+          {
+            "statusCode": 500,
+            "body": {
+              "status": "failed",
+              "message": "Server error"
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+```

package/bin/mock-runner.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+import path from "path";
+import { program } from "commander";
+import startServer from "../src/server.js";
+
+program
+  .name("mock-runner")
+  .description("Run mock APIs from a JSON config")
+  .version("1.0.0");
+
+program
+  .command("start <config>")
+  .option("-p, --port <port>", "port to run server", "3000")
+  .action((config, options) => {
+    const configPath = path.resolve(process.cwd(), config);
+    startServer({ configPath, port: Number(options.port) || 8734 });
+  });
+
+program.parse();

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "view-api",
+  "version": "1.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "server": "nodemon src/server.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "mock-runner": "./bin/mock-runner.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "dependencies": {
+    "commander": "^14.0.2",
+    "cors": "^2.8.5",
+    "dotenv": "^17.2.3",
+    "express": "^5.2.1",
+    "helmet": "^8.1.0",
+    "morgan": "^1.10.1",
+    "nodemon": "^3.1.11"
+  }
+}

package/src/app.js

@@ -0,0 +1,29 @@
+import express from "express";
+import morgan from "morgan";
+import helmet from "helmet";
+import cors from "cors";
+
+// define routes here
+import mockRoutes from "./routes/mock.routes.js";
+
+import "dotenv/config";
+
+export default function createApp(configPath) {
+  const app = express();
+
+  // ==== MIDDLEWARES ====
+  app.use(express.json());
+  app.use(express.urlencoded({ extended: true }));
+  app.use(morgan("dev"));
+  app.use(cors());
+  app.use(helmet());
+
+  app.use((req, _res, next) => {
+    req.mockConfigPath = configPath;
+    next();
+  });
+
+  app.use(mockRoutes);
+
+  return app;
+}

package/src/controllers/mock.controller.js

@@ -0,0 +1,21 @@
+import { handle } from "../services/mock.service.js";
+
+export const handleRequest = async (req, res, next) => {
+  try {
+    // call service to handle request
+    const data = handle(req.mockConfigPath, req.method, req.path);
+    console.log("🚀 ~ handleRequest ~ data:", data);
+
+    if (!data) {
+      return res.status(404).json({
+        status: "failed",
+        message: `No mock defined for ${req.method} ${req.path}`,
+      });
+    }
+
+    // return response
+    return res.status(data.statusCode).json(data.body);
+  } catch (err) {
+    next(err);
+  }
+};

package/src/mocks/mock.json

@@ -0,0 +1,51 @@
+{
+  "version": "1.0.0",
+  "routes": {
+    "GET /products": {
+      "behavior": {
+        "successRate": 50
+      },
+      "responses": {
+        "success": {
+          "statusCode": 200,
+          "body": {
+            "status": "success",
+            "message": "Products fetched wkwk",
+            "data": [
+              {
+                "id": 1,
+                "name": "Product A",
+                "price": 10000,
+                "stock": 50
+              },
+              {
+                "id": 2,
+                "name": "Product B",
+                "price": 15000,
+                "stock": 30
+              }
+            ]
+          }
+        },
+        "errors": [
+          {
+            "statusCode": 500,
+            "body": {
+              "status": "failed",
+              "message": "Server error",
+              "error_code": "SERVER_ERROR"
+            }
+          },
+          {
+            "statusCode": 400,
+            "body": {
+              "status": "failed",
+              "message": "Bad request, invalid parameters",
+              "error_code": "INVALID_PARAMETERS"
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/src/routes/mock.routes.js

@@ -0,0 +1,8 @@
+import express from "express";
+import { handleRequest } from "../controllers/mock.controller.js";
+
+const router = express.Router();
+
+router.use(handleRequest);
+
+export default router;

package/src/server.js

@@ -0,0 +1,10 @@
+import createApp from "./app.js";
+
+export default ({ configPath, port }) => {
+  const server = createApp(configPath);
+
+  server.listen(port, () => {
+    console.log(`  ➜  [API] Server running on:   http://localhost:${port}`);
+    console.log(`  ➜  [API] Using config file:   ${configPath}`);
+  });
+};

package/src/services/mock.service.js

@@ -0,0 +1,15 @@
+import { loadConfig } from "../utils/loadConfig.js";
+import { pickResponse } from "../utils/responsePicker.js";
+
+export const handle = (mockConfigPath, method, path) => {
+  const config = loadConfig(mockConfigPath);
+  const key = `${method} ${path}`;
+
+  const route = config.routes[key];
+
+  if (!route) {
+    return null;
+  }
+
+  return pickResponse(route);
+};

package/src/utils/loadConfig.js

@@ -0,0 +1,6 @@
+import fs from "fs";
+
+export const loadConfig = (configPath) => {
+  const raw = fs.readFileSync(configPath, "utf-8");
+  return JSON.parse(raw);
+};

package/src/utils/responsePicker.js

@@ -0,0 +1,19 @@
+export const pickResponse = (routeConfig) => {
+  const { behavior, responses } = routeConfig;
+  const roll = Math.random() * 100;
+
+  if (roll <= behavior.successRate) {
+    return {
+      statusCode: responses.success.statusCode,
+      body: responses.success.body,
+    };
+  }
+
+  const errors = responses.errors;
+  const error = errors[Math.floor(Math.random() * errors.length)];
+
+  return {
+    statusCode: error.statusCode,
+    body: error.body,
+  };
+};