json-api-mocker 1.0.0

package/README.ch.md

@@ -0,0 +1,216 @@
+# JSON Mock Server
+
+一个轻量级且灵活的 Mock 服务器，通过 JSON 配置快速创建 RESTful API。
+
+<p align="center">
+  <img src="https://img.shields.io/npm/v/json-mock-server" alt="npm 版本" />
+  <img src="https://img.shields.io/npm/l/json-mock-server" alt="许可证" />
+  <img src="https://img.shields.io/npm/dt/json-mock-server" alt="下载量" />
+</p>
+
+## ✨ 特性
+
+- 🚀 通过 JSON 配置快速搭建
+- 🔄 支持 GET、POST、PUT、DELETE 方法
+- 📝 自动数据持久化
+- 🔍 内置分页支持
+- 🛠 可自定义响应结构
+- 💡 TypeScript 支持
+
+## 📦 安装
+
+```bash
+# 使用 npm
+npm install json-mock-server
+
+# 使用 yarn
+yarn add json-mock-server
+
+# 使用 pnpm
+pnpm add json-mock-server
+```
+
+## 🚀 快速开始
+
+### 1. 创建配置文件
+
+在项目根目录创建 `data.json` 文件：
+
+```json
+{
+  "server": {
+    "port": 8080,
+    "baseProxy": "/api"
+  },
+  "routes": [
+    {
+      "path": "/users",
+      "methods": {
+        "get": {
+          "type": "array",
+          "pagination": {
+            "enabled": true,
+            "pageSize": 10,
+            "totalCount": 100
+          },
+          "response": [
+            {
+              "id": 1,
+              "name": "张三",
+              "age": 30,
+              "city": "北京"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+### 2. 启动服务器
+
+```bash
+npx json-mock-server
+```
+
+现在你的 Mock 服务器已经在 `http://localhost:8080` 运行了！
+
+## 📖 配置指南
+
+### 服务器配置
+
+`server` 部分配置基本的服务器设置：
+
+```json
+{
+  "server": {
+    "port": 8080,      // 服务器端口号
+    "baseProxy": "/api" // 所有路由的基础路径
+  }
+}
+```
+
+### 路由配置
+
+每个路由可以支持多个 HTTP 方法：
+
+```json
+{
+  "path": "/users",    // 路由路径
+  "methods": {
+    "get": {
+      "type": "array", // 响应类型：array 或 object
+      "pagination": {  // 可选的分页设置
+        "enabled": true,
+        "pageSize": 10,
+        "totalCount": 100
+      },
+      "response": []   // 响应数据
+    },
+    "post": {
+      "requestSchema": {  // 请求体验证模式
+        "name": "string",
+        "age": "number"
+      },
+      "response": {
+        "success": true
+      }
+    }
+  }
+}
+```
+
+## 🎯 API 示例
+
+### 基本的 CRUD 操作
+
+#### 获取用户列表
+```bash
+curl http://localhost:8080/api/users
+```
+
+#### 获取单个用户
+```bash
+curl http://localhost:8080/api/users/1
+```
+
+#### 创建用户
+```bash
+curl -X POST http://localhost:8080/api/users \
+  -H "Content-Type: application/json" \
+  -d '{"name":"李四","age":25,"city":"上海"}'
+```
+
+#### 更新用户
+```bash
+curl -X PUT http://localhost:8080/api/users/1 \
+  -H "Content-Type: application/json" \
+  -d '{"name":"李四","age":26,"city":"上海"}'
+```
+
+#### 删除用户
+```bash
+curl -X DELETE http://localhost:8080/api/users/1
+```
+
+### 高级用法
+
+#### 分页
+```bash
+# 获取第2页，每页10条数据
+curl http://localhost:8080/api/users?page=2&pageSize=10
+```
+
+#### 自定义响应头
+服务器自动添加以下响应头：
+- `X-Total-Count`：数据总条数（用于分页响应）
+
+## 🔧 高级配置
+
+### 动态路由
+
+你可以在路由中使用 URL 参数：
+
+```json
+{
+  "path": "/users/:id/posts",
+  "methods": {
+    "get": {
+      "type": "array",
+      "response": []
+    }
+  }
+}
+```
+
+### 请求验证
+
+为 POST/PUT 请求添加模式验证：
+
+```json
+{
+  "requestSchema": {
+    "name": "string",
+    "age": "number",
+    "email": "string"
+  }
+}
+```
+
+## 🤝 贡献指南
+
+1. Fork 本仓库
+2. 创建你的特性分支 (`git checkout -b feature/amazing-feature`)
+3. 提交你的改动 (`git commit -m '添加一些很棒的特性'`)
+4. 推送到分支 (`git push origin feature/amazing-feature`)
+5. 开启一个 Pull Request
+
+## 📄 许可证
+
+MIT © [熊海印]
+
+## 🙏 致谢
+
+- 感谢 Express.js 提供出色的 Web 框架
+- 感谢所有贡献者和用户

package/README.md

@@ -0,0 +1,216 @@
+# JSON Mock Server
+
+A lightweight and flexible mock server that uses JSON configuration to quickly create RESTful APIs.
+
+<p align="center">
+  <img src="https://img.shields.io/npm/v/json-mock-server" alt="npm version" />
+  <img src="https://img.shields.io/npm/l/json-mock-server" alt="license" />
+  <img src="https://img.shields.io/npm/dt/json-mock-server" alt="downloads" />
+</p>
+
+## ✨ Features
+
+- 🚀 Quick setup with JSON configuration
+- 🔄 Support for GET, POST, PUT, DELETE methods
+- 📝 Automatic data persistence
+- 🔍 Built-in pagination support
+- 🛠 Customizable response schemas
+- 💡 TypeScript support
+
+## 📦 Installation
+
+```bash
+# 使用 npm
+npm install json-mock-server
+
+# 使用 yarn
+yarn add json-mock-server
+
+# 使用 pnpm
+pnpm add json-mock-server
+```
+
+## 🚀 Quick Start
+
+### 1. Create Configuration File
+
+Create a `data.json` file in your project root:
+
+```json
+{
+  "server": {
+    "port": 8080,
+    "baseProxy": "/api"
+  },
+  "routes": [
+    {
+      "path": "/users",
+      "methods": {
+        "get": {
+          "type": "array",
+          "pagination": {
+            "enabled": true,
+            "pageSize": 10,
+            "totalCount": 100
+          },
+          "response": [
+            {
+              "id": 1,
+              "name": "John",
+              "age": 30,
+              "city": "New York"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+### 2. Start the Server
+
+```bash
+npx json-mock-server
+```
+
+Now your mock server is running at `http://localhost:8080`!
+
+## 📖 Configuration Guide
+
+### Server Configuration
+
+The `server` section configures basic server settings:
+
+```json
+{
+  "server": {
+    "port": 8080,      // Server port number
+    "baseProxy": "/api" // Base path for all routes
+  }
+}
+```
+
+### Route Configuration
+
+Each route can support multiple HTTP methods:
+
+```json
+{
+  "path": "/users",    // Route path
+  "methods": {
+    "get": {
+      "type": "array", // Response type: "array" or "object"
+      "pagination": {  // Optional pagination settings
+        "enabled": true,
+        "pageSize": 10,
+        "totalCount": 100
+      },
+      "response": []   // Response data
+    },
+    "post": {
+      "requestSchema": {  // Request body validation schema
+        "name": "string",
+        "age": "number"
+      },
+      "response": {
+        "success": true
+      }
+    }
+  }
+}
+```
+
+## 🎯 API Examples
+
+### Basic CRUD Operations
+
+#### Get Users List
+```bash
+curl http://localhost:8080/api/users
+```
+
+#### Get Single User
+```bash
+curl http://localhost:8080/api/users/1
+```
+
+#### Create User
+```bash
+curl -X POST http://localhost:8080/api/users \
+  -H "Content-Type: application/json" \
+  -d '{"name":"Alice","age":25,"city":"Boston"}'
+```
+
+#### Update User
+```bash
+curl -X PUT http://localhost:8080/api/users/1 \
+  -H "Content-Type: application/json" \
+  -d '{"name":"Alice","age":26,"city":"Boston"}'
+```
+
+#### Delete User
+```bash
+curl -X DELETE http://localhost:8080/api/users/1
+```
+
+### Advanced Usage
+
+#### Pagination
+```bash
+# Get page 2 with 10 items per page
+curl http://localhost:8080/api/users?page=2&pageSize=10
+```
+
+#### Custom Response Headers
+The server automatically adds these headers:
+- `X-Total-Count`: Total number of items (for paginated responses)
+
+## 🔧 Advanced Configuration
+
+### Dynamic Routes
+
+You can use URL parameters in routes:
+
+```json
+{
+  "path": "/users/:id/posts",
+  "methods": {
+    "get": {
+      "type": "array",
+      "response": []
+    }
+  }
+}
+```
+
+### Request Validation
+
+Add schema validation for POST/PUT requests:
+
+```json
+{
+  "requestSchema": {
+    "name": "string",
+    "age": "number",
+    "email": "string"
+  }
+}
+```
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+MIT © [Xiong Haiyin]
+
+## 🙏 Acknowledgments
+
+- Express.js for the excellent web framework
+- All our contributors and users

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const configPath = process.argv[2] || 'data.json';
+(0, index_1.startServer)(configPath);

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export declare function startServer(configPath?: string): void;
+export { MockServer } from './server';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockServer = void 0;
+exports.startServer = startServer;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const server_1 = require("./server");
+function startServer(configPath = 'data.json') {
+    const fullPath = path_1.default.resolve(process.cwd(), configPath);
+    try {
+        const configContent = fs_1.default.readFileSync(fullPath, 'utf-8');
+        const config = JSON.parse(configContent);
+        const server = new server_1.MockServer(config, configPath);
+        server.start();
+    }
+    catch (error) {
+        console.error('Failed to start server:', error);
+        process.exit(1);
+    }
+}
+if (require.main === module) {
+    startServer();
+}
+var server_2 = require("./server");
+Object.defineProperty(exports, "MockServer", { enumerable: true, get: function () { return server_2.MockServer; } });
+__exportStar(require("./types"), exports);

package/dist/server.d.ts

@@ -0,0 +1,18 @@
+import { Config } from './types';
+export declare class MockServer {
+    private app;
+    private config;
+    private configPath;
+    constructor(config: Config, configPath?: string);
+    private setupMiddleware;
+    private setupRoutes;
+    private saveConfig;
+    private findUserById;
+    private getNextUserId;
+    private createRoute;
+    private handleRequest;
+    private handlePostRequest;
+    private handlePutRequest;
+    private handleDeleteRequest;
+    start(): void;
+}

package/dist/server.js

@@ -0,0 +1,155 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockServer = void 0;
+const express_1 = __importDefault(require("express"));
+const cors_1 = __importDefault(require("cors"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+class MockServer {
+    constructor(config, configPath = 'data.json') {
+        this.app = (0, express_1.default)();
+        this.config = config;
+        this.configPath = path_1.default.resolve(process.cwd(), configPath);
+        this.setupMiddleware();
+        this.setupRoutes();
+    }
+    setupMiddleware() {
+        this.app.use((0, cors_1.default)());
+        this.app.use(express_1.default.json());
+    }
+    setupRoutes() {
+        this.config.routes.forEach((route) => {
+            Object.entries(route.methods).forEach(([method, methodConfig]) => {
+                this.createRoute(route.path, method, methodConfig);
+            });
+        });
+    }
+    saveConfig() {
+        fs_1.default.writeFileSync(this.configPath, JSON.stringify(this.config, null, 2), 'utf-8');
+    }
+    findUserById(id) {
+        const usersRoute = this.config.routes.find(route => route.path === '/users');
+        if (!usersRoute)
+            return null;
+        const getMethod = usersRoute.methods.get;
+        if (!getMethod || !Array.isArray(getMethod.response))
+            return null;
+        return getMethod.response.find(user => user.id === id);
+    }
+    getNextUserId() {
+        const usersRoute = this.config.routes.find(route => route.path === '/users');
+        if (!usersRoute)
+            return 1;
+        const getMethod = usersRoute.methods.get;
+        if (!getMethod || !Array.isArray(getMethod.response))
+            return 1;
+        const maxId = Math.max(...getMethod.response.map(user => user.id));
+        return maxId + 1;
+    }
+    createRoute(path, method, config) {
+        const fullPath = `${this.config.server.baseProxy}${path}`;
+        console.log(`创建路由: ${method.toUpperCase()} ${fullPath}`);
+        switch (method.toLowerCase()) {
+            case 'get':
+                this.app.get(fullPath, this.handleRequest(config));
+                break;
+            case 'post':
+                this.app.post(fullPath, this.handlePostRequest(config));
+                break;
+            case 'put':
+                this.app.put(`${fullPath}/:id`, this.handlePutRequest(config));
+                break;
+            case 'delete':
+                this.app.delete(`${fullPath}/:id`, this.handleDeleteRequest(config));
+                break;
+        }
+    }
+    handleRequest(config) {
+        return (req, res) => {
+            console.log(`收到请求: ${req.method} ${req.url}`);
+            if (config.pagination?.enabled && config.type === 'array') {
+                const page = parseInt(req.query.page) || 1;
+                const pageSize = parseInt(req.query.pageSize) || config.pagination.pageSize;
+                const startIndex = (page - 1) * pageSize;
+                const endIndex = startIndex + pageSize;
+                const data = config.response.slice(startIndex, endIndex);
+                res.header('X-Total-Count', config.pagination.totalCount.toString());
+                res.json(data);
+            }
+            else {
+                res.json(config.response);
+            }
+        };
+    }
+    handlePostRequest(config) {
+        return (req, res) => {
+            console.log(`收到创建请求: ${req.url}`, req.body);
+            const usersRoute = this.config.routes.find(route => route.path === '/users');
+            if (!usersRoute) {
+                return res.status(404).json({ error: '路由未找到' });
+            }
+            const getMethod = usersRoute.methods.get;
+            if (!getMethod || !Array.isArray(getMethod.response)) {
+                return res.status(500).json({ error: '数据格式错误' });
+            }
+            const newUser = {
+                id: this.getNextUserId(),
+                ...req.body
+            };
+            getMethod.response.push(newUser);
+            this.saveConfig();
+            res.status(201).json(newUser);
+        };
+    }
+    handlePutRequest(config) {
+        return (req, res) => {
+            const userId = parseInt(req.params.id);
+            console.log(`收到更新请求: ${req.url}`, req.body);
+            const user = this.findUserById(userId);
+            if (!user) {
+                return res.status(404).json({ error: '用户未找到' });
+            }
+            Object.assign(user, req.body);
+            this.saveConfig();
+            res.json(user);
+        };
+    }
+    handleDeleteRequest(config) {
+        return (req, res) => {
+            const userId = parseInt(req.params.id);
+            console.log(`收到删除请求: ${req.url}`);
+            const usersRoute = this.config.routes.find(route => route.path === '/users');
+            if (!usersRoute) {
+                return res.status(404).json({ error: '路由未找到' });
+            }
+            const getMethod = usersRoute.methods.get;
+            if (!getMethod || !Array.isArray(getMethod.response)) {
+                return res.status(500).json({ error: '数据格式错误' });
+            }
+            const userIndex = getMethod.response.findIndex(user => user.id === userId);
+            if (userIndex === -1) {
+                return res.status(404).json({ error: '用户未找到' });
+            }
+            getMethod.response.splice(userIndex, 1);
+            this.saveConfig();
+            res.json({ success: true, message: '删除成功' });
+        };
+    }
+    start() {
+        this.app.listen(this.config.server.port, () => {
+            console.log(`Mock 服务器已启动:`);
+            console.log(`- 地址: http://localhost:${this.config.server.port}`);
+            console.log(`- 基础路径: ${this.config.server.baseProxy}`);
+            console.log('可用的接口:');
+            this.config.routes.forEach(route => {
+                Object.keys(route.methods).forEach(method => {
+                    console.log(`  ${method.toUpperCase()} http://localhost:${this.config.server.port}${this.config.server.baseProxy}${route.path}`);
+                });
+            });
+        });
+    }
+}
+exports.MockServer = MockServer;

package/dist/types.d.ts

@@ -0,0 +1,26 @@
+export interface ServerConfig {
+    port: number;
+    baseProxy: string;
+}
+export interface PaginationConfig {
+    enabled: boolean;
+    pageSize: number;
+    totalCount: number;
+}
+export interface MethodConfig {
+    type?: 'array' | 'object';
+    pagination?: PaginationConfig;
+    response: any;
+    requestSchema?: Record<string, string>;
+    params?: string[];
+}
+export interface RouteConfig {
+    path: string;
+    methods: {
+        [key: string]: MethodConfig;
+    };
+}
+export interface Config {
+    server: ServerConfig;
+    routes: RouteConfig[];
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "json-api-mocker",
+  "version": "1.0.0",
+  "description": "一个基于 JSON 配置的 Mock 服务器",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "json-mock-server": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "README.ch.md"
+  ],
+  "scripts": {
+    "dev": "nodemon",
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "mock",
+    "server",
+    "json",
+    "api",
+    "typescript",
+    "rest",
+    "api-mock",
+    "mock-server"
+  ],
+  "author": "Xiong Haiyin",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/你的用户名/json-mock-server.git"
+  },
+  "bugs": {
+    "url": "https://github.com/你的用户名/json-mock-server/issues"
+  },
+  "homepage": "https://github.com/你的用户名/json-mock-server#readme",
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.17.1"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.13",
+    "@types/express": "^4.17.13",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^16.18.0",
+    "jest": "^27.5.1",
+    "nodemon": "^2.0.22",
+    "ts-jest": "^27.1.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  }
+}