返回

从 Nest.js 入门:利用 Nest CLI 创建项目和接口

前端

NestJS 是一款专为构建强大、可扩展 Node.js 服务器端应用程序而设计的开发框架。本文将指导您使用 Nest CLI 创建一个新的 NestJS 项目并建立一个简单的接口。让我们开始吧!

1. 安装 Nest CLI

首先,在您的系统上安装 Nest CLI:

npm install -g @nestjs/cli

2. 创建一个新的项目

使用 Nest CLI 创建一个新的 NestJS 项目:

nest new my-nest-app

3. 导航到项目目录

进入新创建的项目目录:

cd my-nest-app

4. 生成一个新的模块

使用 Nest CLI 为您的项目生成一个新的模块,该模块将包含我们的接口:

nest generate module user

5. 创建接口类

在刚创建的 user 模块中,创建一个新的 user.service.ts 文件并添加以下内容:

import { Injectable } from '@nestjs/common';

@Injectable()
export class UserService {
  findAll(): string[] {
    return ['John', 'Jane', 'Tom'];
  }
}

6. 创建接口控制器

user 模块中,创建一个新的 user.controller.ts 文件并添加以下内容:

import { Controller, Get } from '@nestjs/common';
import { UserService } from './user.service';

@Controller('user')
export class UserController {
  constructor(private readonly userService: UserService) {}

  @Get()
  findAll(): string[] {
    return this.userService.findAll();
  }
}

7. 注册模块

在项目的 app.module.ts 文件中,导入并注册 UserModule

import { Module } from '@nestjs/common';
import { UserModule } from './user/user.module';

@Module({
  imports: [UserModule],
})
export class AppModule {}

8. 运行应用程序

运行 NestJS 应用程序:

npm run start

9. 测试接口

使用 cURL 或 Postman 等工具发送 GET 请求到 http://localhost:3000/user,您应该会看到类似以下的响应:

["John", "Jane", "Tom"]

结论

恭喜!您已经成功使用 Nest CLI 创建了一个 NestJS 项目并建立了一个简单的接口。NestJS 强大的特性和易用性使其成为构建可扩展和可维护 Node.js 服务器端应用程序的理想选择。随着您对 NestJS 的深入了解,您将发现它可以简化开发过程并帮助您创建健壮且高效的应用程序。