「项目实战」从0搭建NestJS后端服务(一):初始化项目+手把手整合Swagger接口文档

🚀 前言:为什么要学这个?

hello 我是elk,最近一直在研究NestJS这个框架「努力成长到全栈开发」,也根据网上资料学习了基本的使用方法,想着光使用还不行,实战才是最好的老师。

今天起我将完整记录从零搭建 Node.js 服务的过程。这个系列文章将带你一起探索 NestJs 的世界,即使你现在对 NestJs 只有基础的了解,也没关系,我们可以一边学习一边进步。现在,就让我们开启这段充满挑战与收获的旅程吧!

简介

在这个项目中,我们将基于强大的 NestJs 框架,打造一个专为 vue2-elk-admin「之前自己的写的,目前的mock数据,想着做完集成一下」 后台管理平台服务的 Node.js 应用服务。这个组合将为你的后台管理系统提供坚实的技术支撑,让你的开发工作更加高效、便捷。

🛠️ 初始化项目(注意版本差异!)

bash 复制代码
# 安装CLI
npm install -g @nestjs/cli  # 目前11,当时安装的是10

# 创建项目「推荐选择pnpm」
nest new v2-admin-server

这里有个重要提示:NestJS不同大版本存在配置差异,请根据你的CLI版本选择对应操作

📚 接口文档神器Swagger整合指南

为了让我们的接口更加直观和易于使用,我们将为项目配置 Swagger 接口文档。这将为我们提供一个友好的可视化界面,方便我们查看和测试接口。

为什么需要Swagger?

  • 自动生成可视化API文档
  • 支持在线接口测试
  • 方便前后端协作对接
  • 自动同步接口参数变更

安装插件

安装注意版本兼容

perl 复制代码
# v11执行这个
pnpm install  @nestjs/swagger swagger-ui-express
​
# v10执行这个
pnpm install  @nestjs/swagger@8.1.1 swagger-ui-express@4.6.3

注册插件

  • main.ts
javascript 复制代码
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
​
// 引入swagger配置
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
​
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
​
  // swagger注册配置
  const options = new DocumentBuilder()
    .setTitle('vue2-elk-admin-后端服务')
    .setDescription('vue2-elk-admin-后端服务接口文档')
    .setVersion('1.0')
    .addTag('Nestjs Swagger')
    .build();
​
  const document = SwaggerModule.createDocument(app, options);
  SwaggerModule.setup('api-docs', app, document);
  await app.listen(3000);
}
bootstrap();

激活文档

bash 复制代码
pnpm run start:dev

访问 http://localhost:3000/api-docs 查看文档

📍 下期预告

《从0搭建NestJS后端服务(二):数据库选型与Prisma整合》

我们将探讨:

  • 🔑 MySQL vs PostgreSQL选型对比
  • 🧩 Prisma的配置技巧
  • 🛡️ 数据库敏感信息加密方案

🤝 互动时间

刚接触NestJS的小伙伴 ,在配置过程中遇到了什么问题?
有经验的大佬 ,你们项目中是怎么管理接口文档的?

欢迎在评论区分享你的实战经验!

相关推荐
weixin_4713830332 分钟前
Node.js + Express 入门实战笔记-01-基础
node.js·lua·express
程序员黑豆17 小时前
AI全栈开发系列开篇:从Java全栈到AI应用实战
前端·ai编程·全栈
Rain50921 小时前
2.2 数据基础:数据库集成与 ORM(TypeORM / Prisma)
数据库·人工智能·ai·数据分析·node.js·自动化·ai编程
大家的林语冰21 小时前
npm 不忍了,正式上线“阶段式发布“的新功能,进一步对抗频繁的供应链攻击!
前端·javascript·node.js
天蓝色的鱼鱼1 天前
Node.js 现在能直接跑 TypeScript 了,tsx 和 ts-node 还需要吗?
前端·typescript·node.js
Rain5091 天前
2.3. 安全配置:环境变量与 API 密钥管理
前端·人工智能·后端·安全·ai·node.js·ai编程
小葛要努力1 天前
安装nvm 管理node.js版本实现vue2和vue3项目共存
node.js·vue·nvm
weixin_571667412 天前
[解决] Node.js 安装后 命令找不到
node.js
chengliu05082 天前
从前端转型全栈、 Agent 开发
程序员·全栈
孜孜不倦不忘初心2 天前
mac安装nvm及问题记录
前端·node.js