开源项目 `rest-api-nodejs-mongodb` 使用教程

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

rest-api-nodejs-mongodb/
├── config/
│   └── db.js
├── controllers/
│   ├── authController.js
│   ├── userController.js
│   └── ...
├── models/
│   ├── User.js
│   └── ...
├── routes/
│   ├── authRoutes.js
│   ├── userRoutes.js
│   └── ...
├── middleware/
│   ├── auth.js
│   └── ...
├── utils/
│   └── ...
├── .env
├── .gitignore
├── app.js
├── package.json
└── README.md

目录结构说明

• config/: 包含数据库连接配置文件。
• controllers/: 包含处理业务逻辑的控制器文件。
• models/: 包含数据模型定义文件。
• routes/: 包含路由定义文件。
• middleware/: 包含中间件文件，如身份验证中间件。
• utils/: 包含工具函数或辅助类文件。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• app.js: 项目启动文件。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

app.js

app.js 是项目的入口文件，负责初始化 Express 应用并启动服务器。以下是 app.js 的主要内容：

const express = require('express');
const mongoose = require('mongoose');
const bodyParser = require('body-parser');
const cors = require('cors');
const dotenv = require('dotenv');

dotenv.config();

const app = express();

app.use(cors());
app.use(bodyParser.json());

const PORT = process.env.PORT || 5000;

mongoose.connect(process.env.DB_CONNECT, {
    useNewUrlParser: true,
    useUnifiedTopology: true
}, () => {
    console.log('Connected to DB!');
});

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

启动文件说明

• 引入必要的模块：express, mongoose, body-parser, cors, dotenv。
• 配置环境变量：使用 dotenv 加载 .env 文件中的配置。
• 创建 Express 应用实例：const app = express();。
• 配置中间件：使用 cors 和 body-parser。
• 连接数据库：使用 mongoose.connect 连接 MongoDB。
• 启动服务器：使用 app.listen 监听指定端口。

3. 项目的配置文件介绍

.env

.env 文件用于存储环境变量，如数据库连接字符串、端口号等。以下是一个示例：

PORT=5000
DB_CONNECT=mongodb+srv://<username>:<password>@cluster.mongodb.net/test?retryWrites=true&w=majority

配置文件说明

• PORT: 指定服务器监听的端口号。
• DB_CONNECT: 数据库连接字符串，包含用户名、密码和数据库地址。

config/db.js

db.js 文件负责连接 MongoDB 数据库。以下是 db.js 的主要内容：

const mongoose = require('mongoose');

const connectDB = async () => {
    try {
        await mongoose.connect(process.env.DB_CONNECT, {
            useNewUrlParser: true,
            useUnifiedTopology: true
        });
        console.log('MongoDB connected!!');
    } catch (err) {
        console.log('Failed to connect to MongoDB', err);
    }
};

module.exports = connectDB;

配置文件说明

• 引入 mongoose 模块。
• 定义 connectDB 函数，用于连接数据库。
• 使用 mongoose.connect 方法连接