Nest.js快速启动API项目过程详解

下面是“Nest.js快速启动API项目过程详解”的完整攻略，包括示例说明。

一、安装环境

首先，需要安装Node.js和npm（或者yarn），如果你还没有安装的话，可以参考Node.js官网进行下载和安装。

安装完成后，可以通过以下命令来验证是否安装成功：

node -v
npm -v

执行以上命令会分别输出Node.js和npm（或者yarn）的版本号，说明已经安装成功。

二、创建Nest.js项目

接下来，我们需要通过Nest.js框架提供的工具快速创建一个项目。

在终端中执行如下命令：

npm i -g @nestjs/cli

这个命令会全局安装Nest.js提供的命令行工具，用于快速创建、管理Nest.js项目。

安装完成后，在合适的位置创建一个文件夹（例如，mkdir nest-project），然后进入该文件夹，执行如下命令：

nest new project-name

其中，project-name为你想要创建的项目名称，可以自定义设置。

执行该命令后，会自动生成一个基础的Nest.js项目结构。

三、创建API模块

接下来，我们需要在项目中创建一个API模块。

在终端中执行如下命令：

nest generate module api

这个命令会在项目中创建一个api模块，并自动生成对应的模块、控制器、服务、dto等文件。

四、创建API接口

在创建完api模块后，我们需要在该模块中创建一个API接口。

在终端中执行如下命令：

nest generate controller api/users

其中，api/users是你想要创建的API接口的URL地址，可以自定义设置。执行该命令后，会在api模块中创建一个users控制器，并自动生成对应的控制器、服务、dto等文件。

现在，我们需要在users控制器中实现一个GET请求的API接口，返回一个JSON对象：

import { Controller, Get } from '@nestjs/common';

@Controller('api/users')
export class UsersController {
  @Get()
  getUsers() {
    return { message: 'Hello, Nest.js!' };
  }
}

其中，@Controller('api/users')表示该控制器响应的URL地址为/api/users，@Get()表示该方法响应的HTTP请求方法为GET。当该API接口被访问时，它将返回一个JSON对象：{ message: 'Hello, Nest.js!' }。

现在，我们可以启动该Nest.js项目，访问这个API接口。在终端中执行如下命令：

npm run start

这个命令会启动Nest.js项目，并监听3000端口（默认值）。然后，我们可以在浏览器中访问http://localhost:3000/api/users，就能看到返回的JSON对象了。

五、添加数据库支持

如果我们想要在Nest.js项目中使用数据库，可以使用Nest.js提供的TypeORM模块。

首先，我们需要安装TypeORM和相应的数据库驱动。例如，如果你想要使用MySQL数据库，可以执行如下命令：

npm install --save @nestjs/typeorm typeorm mysql

然后，在app.module.ts文件中导入TypeORM模块和相应的数据库驱动，并进行配置：

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { UsersModule } from './users/users.module';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'root',
      password: '123456',
      database: 'nest_test',
      entities: [__dirname + '/**/*.entity{.ts,.js}'],
      synchronize: true,
    }),
    UsersModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

其中，TypeOrmModule.forRoot方法用于配置数据库连接。可以根据实际情况修改host、port、username、password、database等选项。

六、添加数据库实体

接下来，我们需要在项目中创建一个User实体，用于映射关系数据库中的用户表。

在终端中执行如下命令：

nest generate entity users

然后，在src/users/users.entity.ts文件中实现User实体：

import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  age: number;

  @Column()
  email: string;
}

其中，@Entity()表示该类是一个实体类，@Column()表示该属性对应数据库中的一列。

七、添加数据库服务

接下来，我们需要在项目中创建一个UserService服务，用于对用户数据进行CRUD操作。

在终端中执行如下命令：

nest generate service users

然后，在src/users/users.service.ts文件中实现UserService服务：

import { Injectable } from '@nestjs/common';
import { Repository } from 'typeorm';
import { InjectRepository } from '@nestjs/typeorm';
import { User } from './users.entity';

@Injectable()
export class UsersService {
  constructor(
    @InjectRepository(User) private usersRepository: Repository<User>,
  ) {}

  async findAll(): Promise<User[]> {
    return this.usersRepository.find();
  }

  async findById(id: number): Promise<User> {
    return this.usersRepository.findOne(id);
  }

  async create(user: User): Promise<User> {
    return this.usersRepository.save(user);
  }

  async update(user: User): Promise<User> {
    return this.usersRepository.save(user);
  }

  async delete(id: number): Promise<void> {
    await this.usersRepository.delete(id);
  }
}

其中，@Injectable()表示该类是一个可注入的依赖项，@InjectRepository(User)表示该依赖项依赖于User实体对应的仓库，它可以实现对User实体的CRUD操作。

八、添加API接口

现在，我们已经具备了使用数据库的基础条件，接下来，我们需要在api模块中创建一个用户API接口。

在终端中执行如下命令：

nest generate controller api/users

然后，在src/api/users.controller.ts文件中实现API接口：

import { Controller, Get, Post, Put, Delete, Param, Body } from '@nestjs/common';
import { UsersService } from '../../users/users.service';
import { User } from '../../users/users.entity';

@Controller('api/users')
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Get()
  async findAll(): Promise<User[]> {
    return this.usersService.findAll();
  }

  @Get(':id')
  async findById(@Param() params): Promise<User> {
    return this.usersService.findById(params.id);
  }

  @Post()
  async create(@Body() user: User): Promise<User> {
    return this.usersService.create(user);
  }

  @Put()
  async update(@Body() user: User): Promise<User> {
    return this.usersService.update(user);
  }

  @Delete(':id')
  async delete(@Param() params): Promise<void> {
    return this.usersService.delete(params.id);
  }
}

其中，@Get()、@Post()、@Put()和@Delete()分别表示HTTP请求方法为GET、POST、PUT和DELETE，@Param()表示获取URL路径中的参数，@Body()表示获取请求体中的参数。

现在，我们可以启动该Nest.js项目，访问这个API接口。在终端中执行如下命令：

npm run start

然后，我们可以使用Postman或其他HTTP客户端工具，来测试这些API接口。例如，我们可以使用PUT请求，来更新一个用户的信息：

PUT http://localhost:3000/api/users

{"id": 1, "name": "Tom", "age": 30, "email": "[e-mail]"}

以上就是“Nest.js快速启动API项目过程详解”的完整攻略，示例说明了如何创建API模块、创建API接口、添加数据库支持、添加数据库实体和添加数据库服务。希望对你有所帮助。