NestJS——创建项目、编写User模块

news2025/7/20 11:00:44

个人简介

👀个人主页：前端杂货铺
🙋‍♂️学习方向：主攻前端方向，正逐渐往全干发展
📃个人状态：研发工程师，现效力于中国工业软件事业
🚀人生格言：积跬步至千里，积小流成江海
🥇推荐学习：🍍前端面试宝典 🎨100个小功能 🍉Vue2 🍋Vue3 🍓Vue2/3项目实战 🥝Node.js实战 🍒Three.js

🌕个人推广：每篇文章最下方都有加入方式，旨在交流学习&资源分享，快加入进来吧

文章目录

- 创建 NestJS 项目
- Hello World！
- User 模块
- 总结

创建 NestJS 项目

全局安装 nestjs 脚手架。

cnpm i -g @nestjs/cli

查看 nest 版本。

nest --version

在这里插入图片描述

创建名为 nestjs-demo 的项目。

nest new nestjs-demo

等待一会儿，显示如下内容，则安装成功。

在这里插入图片描述

Hello World！

打开我们刚刚创建好的 nestjs-demo 项目，终端键入如下命令运行。

npm	start:dev

在浏览器打开 3000 端口。

在这里插入图片描述

User 模块

首先，我们调整项目内容如下。

在这里插入图片描述

创建 User 模块。

// 创建 User 模块
nest g module user

// 创建 User 控制器，不创建测试文件
nest g controller user --no-spec

// 创建 User 服务，不创建测试文件
nest g service user --no-spec

我们将得到如下的目录结构。

在这里插入图片描述

在 main.ts 中我们为所有注册的路由设置一个全局前缀 /api。

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

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  // 为所有注册的路由设置一个全局前缀
  app.setGlobalPrefix("api");
  await app.listen(3000);
}
bootstrap();

在 user.controller.ts 中添加 获取用户信息 和 添加用户信息 的控制。

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

@Controller("user")
export class UserController {
  constructor(private userService: UserService) {}
  @Get()
  getUsers(): any {
    return this.userService.getUsers();
  }
  @Post()
  addUser(): any {
    return this.userService.addUser();
  }
}

在 user.service.ts 中添加相应的响应逻辑。

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

@Injectable()
export class UserService {
  getUsers(): any {
    return {
      code: 0,
      data: [],
      msg: "请求用户列表成功",
    };
  }
  addUser(): any {
    return {
      code: 0,
      data: {},
      msg: "添加用户成功",
    };
  }
}