Node-JWT 认证API项目启动与配置教程

1. 项目目录结构及介绍

开源项目 node-jwt-authentication-api 的目录结构如下所示：

node-jwt-authentication-api/
├── config/                # 配置文件目录
│   ├── config.js          # 主配置文件
│   └── db.js              # 数据库配置文件
├── models/                # 数据模型目录
│   ├── role.js            # 角色模型
│   ├── user.js            # 用户模型
│   └── ...                # 其他模型
├── routes/                # 路由目录
│   ├── auth.js            # 认证相关路由
│   ├── user.js            # 用户相关路由
│   └── ...                # 其他路由
├── controllers/           # 控制器目录
│   ├── authController.js  # 认证控制器
│   ├── userController.js  # 用户控制器
│   └── ...                # 其他控制器
├── middlewares/           # 中间件目录
│   ├── authMiddleware.js  # 认证中间件
│   └── ...                # 其他中间件
├── app.js                 # 主应用文件
├── package.json           # 项目依赖及配置文件
└── ...                    # 其他文件和目录

• config/：包含项目的配置文件，如数据库连接和项目基础配置。
• models/：定义了项目中使用的数据模型，如用户信息和角色信息。
• routes/：定义了不同的路由路径及其对应的处理器。
• controllers/：包含了处理路由逻辑的控制器。
• middlewares/：包含了项目使用的中间件，如认证中间件。
• app.js：是项目的入口文件，在这里创建和配置了Express应用。
• package.json：定义了项目的依赖关系以及其他配置信息。

2. 项目的启动文件介绍

项目的启动文件是 app.js。以下是启动文件的主要内容：

const express = require('express');
const bodyParser = require('body-parser');
const mongoose = require('mongoose');
const config = require('./config/config');

// 连接数据库
mongoose.connect(config.db.url, { useNewUrlParser: true, useUnifiedTopology: true });

const app = express();

// 使用中间件解析请求体
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

// 导入路由
app.use('/api/auth', require('./routes/auth'));
app.use('/api/user', require('./routes/user'));
// ... 可能还有其他路由

// 启动服务器
const PORT = config.app.port;
app.listen(PORT, () => {
    console.log(`Server is running on port ${PORT}`);
});

在 app.js 文件中，我们首先引入了必要的模块，然后连接数据库，创建了一个Express应用，配置了中间件来解析请求体，导入了路由，并最终在指定的端口上启动了服务器。

3. 项目的配置文件介绍

项目的配置文件包括 config.js 和 db.js。

config.js 文件包含了项目的基础配置，如下所示：

module.exports = {
    app: {
        port: 3000
    },
    db: {
        url: 'mongodb://localhost:27017/node-jwt-authentication-api'
    }
    // ... 可能还有其他配置
};

db.js 文件负责配置和连接数据库：

const mongoose = require('mongoose');
const config = require('./config');

mongoose.connect(config.db.url, { useNewUrlParser: true, useUnifiedTopology: true });

const db = mongoose.connection;
db.on('error', console.error.bind(console, 'connection error:'));
db.once('open', function() {
    console.log("Connected successfully to MongoDB");
});

module.exports = db;

在 db.js 中，我们使用 mongoose 连接到MongoDB数据库，并监听连接错误和成功事件，以便在控制台输出相应的日志信息。