Express-JSDoc-Swagger 项目启动与配置教程

1. 项目目录结构及介绍

express-jsdoc-swagger/
├── .env           # 环境变量配置文件
├── .gitignore     # Git 忽略文件
├── .vscode        # VSCode 配置文件夹
├── app.js         # 应用启动文件
├── bin            # 脚本文件目录
│   └── www        # 启动应用的脚本
├── config         # 配置文件目录
│   ├── config.js  # 主配置文件
│   └── ...        # 其他配置文件
├── controllers    # 控制器目录
│   └── ...        # 具体控制器文件
├── doc            # 文档目录
├── models         # 数据模型目录
│   └── ...        # 具体模型文件
├── routes         # 路由目录
│   └── ...        # 具体路由文件
├── services       # 服务目录
│   └── ...        # 具体服务文件
├── test           # 测试目录
├── tools          # 工具目录
└── views          # 视图目录

• .env: 存储环境变量，用于配置应用在不同环境下的参数。
• .gitignore: 指定Git应该忽略的文件和文件夹。
• .vscode: 存储Visual Studio Code的配置文件，用于统一开发环境。
• app.js: 应用的主入口文件，用于启动和配置Express应用。
• bin: 存储用于启动应用的脚本文件。
• config: 存储应用配置的目录，包括数据库配置、应用设置等。
• controllers: 存储控制器，用于处理请求和响应。
• doc: 存储项目文档。
• models: 存储数据库模型，用于定义数据结构。
• routes: 存储路由定义，用于映射请求到相应的控制器。
• services: 存储业务逻辑服务。
• test: 存储自动化测试代码。
• tools: 存储工具类代码。
• views: 存储视图模板，如果使用模板引擎的话。

2. 项目的启动文件介绍

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

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

// 中间件配置
app.use(express.json());
app.use(express.urlencoded({ extended: false }));

// 路由配置
require('./routes')(app);

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

module.exports = server;

在这个文件中，我们首先导入了express库并创建了一个express应用实例。然后，导入了配置文件config/config.js，配置了中间件，如express.json()用于解析JSON格式的请求体。接着，导入了路由配置，并将应用实例传递给路由函数。最后，使用app.listen()启动服务器。

3. 项目的配置文件介绍

项目的配置文件位于config/config.js。以下是配置文件的基本内容：

module.exports = {
  port: process.env.PORT || 3000,  // 应用端口
  // ... 其他配置项
};

在这个配置文件中，我们使用process.env.PORT获取环境变量中定义的端口，如果未定义则默认使用3000端口。这样的配置方式允许我们在不同的环境中（如开发环境、测试环境、生产环境）通过设置环境变量来改变应用的配置，而无需修改代码。