JWT API 项目使用教程

1. 项目目录结构及介绍

jwt-api/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── services/
├── config/
│   ├── default.json
│   └── production.json
├── middleware/
├── public/
├── test/
├── .env
├── .gitignore
├── package.json
├── README.md
└── server.js

目录结构介绍

• app/: 包含应用程序的主要逻辑代码。
  • controllers/: 处理请求和响应的控制器。
  • models/: 数据库模型定义。
  • routes/: 定义API路由。
  • services/: 业务逻辑服务。
• config/: 配置文件目录，包含不同环境的配置文件。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
• middleware/: 中间件目录，包含自定义中间件。
• public/: 静态文件目录，如图片、CSS、JavaScript文件等。
• test/: 测试文件目录。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。
• server.js: 项目启动文件。

2. 项目启动文件介绍

server.js

server.js 是项目的启动文件，负责启动服务器并监听端口。以下是文件的主要内容：

const express = require('express');
const app = express();
const port = process.env.PORT || 3000;

// 引入路由
const routes = require('./app/routes');

// 使用中间件
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

// 使用路由
app.use('/api', routes);

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

启动步骤

1. 安装依赖：npm install
2. 启动服务器：npm start

3. 项目的配置文件介绍

config/default.json

default.json 是项目的默认配置文件，包含一些通用的配置项。

{
  "port": 3000,
  "jwtSecret": "your_jwt_secret_key",
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "name": "jwt_api_db"
  }
}

config/production.json

production.json 是生产环境的配置文件，通常会覆盖默认配置。

{
  "port": 8080,
  "jwtSecret": "production_jwt_secret_key",
  "database": {
    "host": "production_db_host",
    "user": "production_db_user",
    "password": "production_db_password",
    "name": "production_jwt_api_db"
  }
}

.env

.env 文件用于存储环境变量，通常用于本地开发。

PORT=3000
JWT_SECRET=your_jwt_secret_key
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=
DB_NAME=jwt_api_db

配置加载

项目使用 config 包来加载配置文件，根据环境变量 NODE_ENV 来选择加载 default.json 或 production.json。

const config = require('config');

const port = config.get('port');
const jwtSecret = config.get('jwtSecret');
const dbConfig = config.get('database');

通过以上配置，项目可以根据不同的环境加载相应的配置，确保在不同环境下正常运行。