开源项目 wow_api 使用教程

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

wow_api/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.js
├── config/
│   ├── default.json
│   ├── production.json
│   └── test.json
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── server.js
└── package.json

• README.md: 项目说明文件。
• app/: 应用的主要代码目录。
  • controllers/: 存放控制器文件。
  • models/: 存放数据模型文件。
  • views/: 存放视图文件。
  • routes.js: 路由配置文件。
• config/: 配置文件目录。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
  • test.json: 测试环境配置文件。
• public/: 静态资源目录。
  • css/: 样式文件。
  • js/: 脚本文件。
  • images/: 图片文件。
• server.js: 项目启动文件。
• package.json: 项目依赖和脚本配置文件。

2. 项目的启动文件介绍

项目的启动文件是 server.js。该文件主要负责启动服务器，加载配置，并初始化应用。以下是 server.js 的基本结构：

const express = require('express');
const app = express();
const config = require('./config/default.json');

app.use(express.static('public'));
app.use('/', require('./app/routes'));

const PORT = process.env.PORT || config.port;

app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

• 引入依赖: 引入 express 和其他必要的模块。
• 配置静态资源: 使用 express.static 配置静态资源目录。
• 路由配置: 加载应用的路由配置。
• 启动服务器: 监听指定端口，启动服务器。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，主要包括 default.json, production.json, 和 test.json。

default.json

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "dbname": "wow_api"
  }
}

• port: 默认端口号。
• database: 数据库连接配置。

production.json

{
  "port": 8080,
  "database": {
    "host": "production_host",
    "user": "prod_user",
    "password": "prod_password",
    "dbname": "wow_api_prod"
  }
}

• port: 生产环境端口号。
• database: 生产环境数据库连接配置。

test.json

{
  "port": 3001,
  "database": {
    "host": "test_host",
    "user": "test_user",
    "password": "test_password",
    "dbname": "wow_api_test"
  }
}

• port: 测试环境端口号。
• database: 测试环境数据库连接配置。

这些配置文件可以根据不同的运行环境加载不同的配置，确保应用在不同环境下正常运行。