🚀 前言:为什么要学这个?
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/[email protected] [email protected]
注册插件
- 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的小伙伴 ,在配置过程中遇到了什么问题?
有经验的大佬 ,你们项目中是怎么管理接口文档的?
欢迎在评论区分享你的实战经验!