Mockit 项目教程

1. 项目的目录结构及介绍

Mockit 项目的目录结构如下：

mockit/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   └── production.json
│   ├── routes/
│   │   └── api.js
│   ├── controllers/
│   │   └── mockController.js
│   └── utils/
│       └── logger.js
└── public/
    └── index.html

目录结构介绍

• README.md: 项目说明文件，包含项目的简介、安装步骤、使用说明等。
• package.json: 项目的依赖管理文件，包含项目的依赖包、脚本命令等。
• src/: 项目的源代码目录。
  • index.js: 项目的入口文件，负责启动应用。
  • config/: 配置文件目录，包含不同环境的配置文件。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录，定义了应用的路由规则。
    • api.js: API 路由文件。
  • controllers/: 控制器文件目录，处理业务逻辑。
    • mockController.js: 处理 mock 数据的控制器。
  • utils/: 工具函数目录，包含一些通用的工具函数。
    • logger.js: 日志记录工具。
• public/: 静态文件目录，包含前端静态资源。
  • index.html: 前端入口 HTML 文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，该文件负责启动应用。以下是 index.js 的主要内容：

const express = require('express');
const config = require('config');
const logger = require('./utils/logger');
const apiRoutes = require('./routes/api');

const app = express();
const port = config.get('port');

app.use(express.json());
app.use('/api', apiRoutes);

app.listen(port, () => {
  logger.info(`Server is running on port ${port}`);
});

启动文件介绍

• express: 引入 Express 框架，用于创建 Web 服务器。
• config: 引入配置模块，用于读取配置文件中的配置项。
• logger: 引入日志记录工具，用于记录应用的运行日志。
• apiRoutes: 引入 API 路由模块，定义了应用的路由规则。
• app.use(express.json()): 使用 Express 的 JSON 中间件，解析请求体中的 JSON 数据。
• app.use('/api', apiRoutes): 将 API 路由挂载到 /api 路径下。
• app.listen(port, ...): 启动服务器，监听指定端口。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/ 目录下，包含 default.json 和 production.json 两个文件。

default.json

{
  "port": 3000,
  "logLevel": "info",
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "mockit"
  }
}

production.json

{
  "port": 8080,
  "logLevel": "warn",
  "database": {
    "host": "production-db",
    "port": 27017,
    "name": "mockit-prod"
  }
}

配置文件介绍

• port: 应用监听的端口号。
• logLevel: 日志记录的级别，可选值为 info、warn、error 等。
• database: 数据库配置项。
  • host: 数据库主机地址。
  • port: 数据库端口号。
  • name: 数据库名称。

default.json 是默认配置文件，production.json 是生产环境配置文件。应用会根据环境变量加载相应的配置文件。