NestJS Restful 最佳实践项目启动与配置教程

1. 项目目录结构及介绍

本项目是基于 NestJS 框架的一个最佳实践项目。以下是项目的目录结构及各部分功能的简要介绍：

• node_modules/：存放项目依赖的第三方模块。
• src/：源代码目录，包含项目的所有业务逻辑。
  • app.controller.ts：根控制器，用于处理HTTP请求。
  • app.module.ts：根模块，用于定义项目的基本模块。
  • app.service.ts：根服务，用于封装业务逻辑。
  • common/：公共模块，包含一些通用模块，如异常过滤器、拦截器等。
  • modules/：业务模块目录，每个模块都有独立的控制器、服务和模型。
• test/：测试目录，存放单元测试和集成测试代码。
• e2e/：端到端测试目录。
• package.json：项目配置文件，定义了项目的依赖、脚本等。
• tsconfig.json：TypeScript 配置文件，定义了 TypeScript 编译器的选项。
• .gitignore：Git 忽略文件，定义了 Git 忽略提交的文件和目录。

2. 项目的启动文件介绍

项目的启动文件为 src/main.ts，以下是该文件的简要介绍：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

main.ts 文件中，我们使用 NestFactory 来创建一个 Nest 应用实例，并将根模块 AppModule 传入。之后，调用 listen 方法启动 HTTP 服务器，默认监听 3000 端口。

3. 项目的配置文件介绍

项目的配置文件为 src/config/ 目录下的 app.config.ts，以下是该文件的简要介绍：

export default {
  port: 3000,
  database: {
    host: 'localhost',
    port: 3306,
    user: 'root',
    password: 'password',
    database: 'mydb',
  },
  // 其他配置...
};

在 app.config.ts 文件中，我们定义了一些全局配置，如服务器端口、数据库连接信息等。这些配置可以在项目中的各个模块中被引用和使用，以便于统一管理和修改。在实际项目中，还可以根据需要添加更多的配置项。