NestJS 系列教程（十一）：集成 Swagger 实现自动 API 文档与接口测试

📘 NestJS 系列教程（十一）：集成 Swagger 实现自动 API 文档与接口测试

✨ 本篇目标

你将学会：

• 安装并配置 Swagger 文档模块
• 为接口、DTO 添加元信息，提升文档可读性
• 自定义文档标题、描述、版本等元信息
• 使用 Swagger 提供的 Web UI 测试接口

---

🧩 为什么使用 Swagger？

Swagger 是目前最主流的 RESTful API 文档生成与测试标准，Nest 提供了 @nestjs/swagger 模块用于自动集成。

优点包括：

• 接口一变动，文档自动同步更新
• 前后端可在线对接口进行联调
• 自动生成字段描述、类型、必填性等结构信息
• 提供「Try it out」功能，可直接调试 API

---

📦 安装 Swagger 模块

npm install --save @nestjs/swagger swagger-ui-express

---

🧰 在 main.ts 中初始化 Swagger

打开 src/main.ts，添加如下内容：

import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';async function bootstrap() {const app = await NestFactory.create(AppModule);// 配置 Swagger 文档元信息const config = new DocumentBuilder().setTitle('NestJS 示例文档'