Easy-Mock 使用及搭建教程

Easy-Mock 使用及搭建教程

项目地址:https://gitcode.com/gh_mirrors/ea/easy-mock

1. 项目目录结构及介绍

在 easy-mock 项目中，目录结构大致如下：

easy-mock/
│
├── config/      # 配置文件目录
│   ├── default.json    # 默认配置文件
│   └── local.json     # 本地覆盖默认配置的文件
│
├── src/         # 代码源文件
│   ├── app.js        # 主应用入口文件
│   ├── routes/       # 路由相关文件
│   ├── services/     # 业务逻辑处理
│   └── utils/        # 工具函数
│
├── public/      # 静态资源目录
│
├── package.json  # 项目依赖文件
└── ...

• config/: 存放项目配置，包括默认配置和可覆盖本地配置。
• src/: 代码主体，包含了项目的主要功能实现。
• app.js: 应用的主入口文件，负责初始化和启动服务。
• routes/: 定义应用程序的路由，处理HTTP请求。
• services/: 实现业务逻辑的服务层。
• utils/: 提供各种通用工具函数。

2. 项目启动文件介绍

项目启动主要通过运行 npm start 命令，这会执行 package.json 中定义的脚本。实际执行的是 node src/app.js 命令，该命令启动了Easy-Mock服务器。

在 src/app.js 文件中，主要进行了以下操作：

1. 导入必要的模块。
2. 加载配置文件。
3. 初始化Express应用实例。
4. 注册路由和中间件。
5. 监听指定端口并启动服务。

// 导入模块
const express = require('express');
const bodyParser = require('body-parser');

// 加载配置
const config = require('./config');

// 创建Express应用
const app = express();

// 设置中间件
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));

// 注册路由
require('./routes')(app);

// 启动服务
app.listen(config.port, () => {
  console.log(`Easy-Mock 启动成功，监听端口 ${config.port}`);
});

3. 项目的配置文件介绍

easy-mock 使用 node-config 库管理配置。配置文件位于 config/ 目录下：

• default.json: 包含默认配置，如服务器端口号、数据库连接等。这些配置在所有环境中都会生效。
• local.json: 用于本地开发时覆盖默认配置，不会被版本控制，可以存放敏感信息，如数据库密码。

配置示例：

{
  "port": 7300,
  "host": "0.0.0.0",
  "pageSize": 30,
  "proxy": false,
  "db": "mongodb://localhost/easy-mock",
  "unsplashClientId": "",
  "redis": {
    "keyPrefix": "[Easy Mock]",
    "port": 6379,
    "host": "127.0.0.1"
  }
}

在上述配置中：

• port：设置服务器监听的端口号。
• host：服务器绑定的IP地址。
• db：MongoDB数据库连接字符串。
• redis：Redis配置，包括键前缀和服务器连接信息。

为了适应不同环境，例如生产或测试，你可以创建更多的配置文件，如 development.json 或 production.json，并在运行时加载相应环境的配置。更多信息可以查阅 node-config 文档。

easy-mock A persistent service that generates mock data quickly and provids visualization view. 项目地址: https://gitcode.com/gh_mirrors/ea/easy-mock