APIGit, the Git platform for API management | APIGIT MockServer - 由 Express.js 和 Node.js 提供支持的云沙箱

APIGIT MockServer - 由 Express.js 和 Node.js 提供支持的云沙箱

APIGit

2024-11-15

APIGIT MockServer powered by expressjs and node

创建模拟 API 通常是软件开发的一个重要部分，无论是用于测试还是快速原型设计。模拟服务器，一个强大的工具，环绕Express.js提供一个简化的环境来定义模拟服务器行为，而无需手动设置和配置 Express 应用程序。

MockServer 本质上是运行在 Node.js 沙盒环境中的 Express.js 应用的包装器。它可以帮助您快速创建模拟 API 并使用简单的定义处理各种 HTTP 请求。这篇博文将向您介绍 MockServer，解释其功能，并通过几个示例展示入门的简单性。

MockServer的主要功能

Express.js 包装器：MockServer 环绕 Express.js，使得已经了解 Express.js 的开发人员能够熟悉并易于使用。
预安装的库：流行的 JavaScript 库，例如lodash，moment，faker等都是预先安装的，简化了动态模拟响应的创建。
支持路由和中间件：像在 Express 应用程序中一样定义路由和中间件。
状态数据：使用全局状态变量轻松维护请求之间的数据，使其完美地模拟真实世界的行为。
模块化组织：Mock服务器脚本采用模块化组织，类似于日常开发实践，易于管理和重用代码。

MockServer 的工作原理

MockServer 的工作原理是允许你使用以下方式定义 API 路由**mock对象。mock对象是一个全局实例，它包装了一个 Express.js 应用程序，并支持通过mock.define()**功能。它提供了 Express.js 的灵活性，使得创建和管理用于测试和开发目的的 API 变得简单。

以下是 MockServer 如何简化创建 API 的概述：

使用 mock.define()定义路线和请求处理程序。
使用标准 Express.js 方法，例如req 和 res处理 HTTP 请求和响应。
预安装的库无需手动安装，让您专注于定义模拟逻辑。

示例：定义路由和中间件

以下示例显示了使用 MockServer 创建路由是多么简单：

const { routeCallBackFunc } = require('./util.js');

// Define routes using mock.define(path, method, handler)
mock.define("/user/:name", "POST", function(req, res) {
  // Handle the request
  res.status(404).send("User not found");
});

mock.define("/user/:name", "DELETE", function(req, res) {
  res.status(200).send("User deleted successfully");
});

// Use request handlers from separate files
mock.define("/user/:name", "POST", routeCallBackFunc);

此示例演示如何使用mock.define()创建 POST 和 DELETE 路由。路由定义与标准 Express.js 应用程序类似，确保 API 结构熟悉。

将中间件与 MockServer 结合使用

就像在 Express.js 中一样，您可以使用中间件在请求到达最终路由处理程序之前对其进行处理：

function mw1(req, res, next) {
  console.log("Middleware 1 executed");
  next();
}

function mw2(req, res, next) {
  console.log("Middleware 2 executed");
  next();
}

mock.use(mw1);
mock.use(mw2);

// Define middleware for a specific path
mock.use('/specific-path', (req, res, next) => {
  console.log('Middleware for /specific-path executed');
  next();
});

这 mock.use()函数可用于定义所有路由或特定路径的中间件，就像在 Express 应用程序中一样。

处理请求和响应

MockServer 提供了一种使用标准 Express.js 约定与请求和响应交互的简单方法。以下是一些常见任务的示例：

处理路由参数和查询参数

mock.define('/repository/:user/:repo', 'GET', (req, res) => {
  const { user, repo } = req.params;
  res.json({
    message: 'Repository Details',
    user: user,
    repo: repo
  });
});

mock.define('/search', 'GET', (req, res) => {
  const { keyword, page, limit } = req.query;
  res.json({
    message: 'Search Parameters Received',
    keyword: keyword || 'none',
    page: page ? parseInt(page, 10) : 1,
    limit: limit ? parseInt(limit, 10) : 10
  });
});

设置响应状态和标头

mock.define('/not-found', 'GET', (req, res) => {
  res.status(404).json({
    message: 'Resource not found',
    code: 404
  });
});

mock.define('/single-header', 'GET', (req, res) => {
  res.set('Content-Type', 'application/json');
  res.set('X-Custom-Header', ['value1', 'value2']);
  res.json({ message: 'Headers set successfully!' });
});

使用预安装的库

MockServer 预装了流行的 JavaScript 库，因此您可以在模拟定义中直接使用它们：

const _ = require('lodash');
const moment = require('moment');
const { faker } = require('@faker-js/faker');

mock.define('/test-libs', 'GET', (req, res) => {
  const randomUser = {
    id: faker.datatype.uuid(),
    name: faker.name.findName(),
    email: faker.internet.email()
  };
  res.json({
    currentDate: moment().format(),
    activeUsers: _.filter([{ active: true }, { active: false }], { active: true }),
    randomUser: randomUser
  });
});

这些库可帮助您轻松创建丰富的动态响应，而无需额外安装。如果您需要未列出的库，请联系 APIGIT，我们将快速评估并添加它。支持的库包括：

@faker-js/faker（v9.2.0）- 数据生成器
形容词（v8.17.1）- JSON 模式验证
base64-js（v1.5.1）-Base64 编码/解码
cors（v2.8.5） - 跨源资源共享中间件
jsonwebtoken（v9.0.2）- JWT 创建和验证
洛达什（v4.17.21）- 通用实用程序
片刻(v2.30.1) - 时间和日期处理
唯一标识（v11.0.3） - UUID 生成器
验证器（v13.12.0）- 验证助手

使用 MockServer 的状态数据

MockServer提供了一个state对象，它允许您在请求之间存储和检索数据，从而轻松模拟持久状态：

// Create a stateful list of users
state.users = state.users || [];

mock.define('/users', 'POST', (req, res) => {
  if (!req.body.username) {
    return res.status(400).json({ status: "error", details: "Missing username" });
  }

  state.users.push(req.body);
  return res.status(200).json({ status: "ok" });
});

使用 MockServer 的模块化模拟脚本

为了保持代码更整洁、更有条理，MockServer 支持以模块化方式将模拟脚本拆分为多个文件，类似于日常开发实践。通常，你会有一个main.js文件定义了所有路由，然后需要来自单独文件的处理程序定义。这样您就可以为路由处理程序创建可重复使用、结构良好的模块，从而使您的代码库易于维护。

例如：

主.js：定义所有路由的主文件，需要其他文件来定义处理程序。处理程序模块需要放在文件的开头，以提高可读性和组织性。例如，可以在一个文件中定义添加或删除用户等处理程序，然后使用module.exports。

// main.js

// Require handler modules at the top
const { userPostHandler, userDeleteHandler } = require('./handlers/userHandlers');

// Define routes
mock.define('/user/:name', 'POST', userPostHandler);
mock.define('/user/:name', 'DELETE', userDeleteHandler);

处理程序/userHandlers.js：一个单独的文件，导出函数来处理不同的用户相关请求，使用module.exports将它们一起导出。

// handlers/userHandlers.js

function userPostHandler(req, res) {
  res.status(404).send('User not found');
}

function userDeleteHandler(req, res) {
  res.status(200).send('User deleted successfully');
}

module.exports = {
  userPostHandler,
  userDeleteHandler
};