Nest.js 实战 (三)：使用 Swagger 优雅地生成 API 文档

什么是 Swagger ?

Swagger 是一组围绕 OpenAPI 规范构建的开源工具，可以帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具 包括：

• Swagger Editor：基于浏览器的编辑器，您可以在其中编写 OpenAPI 定义
• Swagger UI：将 OpenAPI 定义呈现为交互式文档
• Swagger Codegen：从 OpenAPI 定义中生成服务器存根和客户端库
• Swagger Editor Next（beta）：基于浏览器的编辑器，您可以在其中编写和查看 OpenAPI 和 AsyncAPI 定义
• Swagger Core：用于创建、使用和处理 OpenAPI 定义的 Java 相关库
• Swagger Parser：用于解析 OpenAPI 定义的独立库
• Swagger APIDom：提供了一个单一的、统一的结构，用于跨各种描述语言和序列化格式描述 API

Nest 集成 Swagger

1. 安装依赖

pnpm add @nestjs/swagger swagger-ui-express

2. 在 main.ts 文件中定义并初始化 SwaggerModule 类

 import {
    NestFactory } from '@nestjs/core';
 import {
    DocumentBuilder, SwaggerModule } from '@nestjs/swagger';

 import {
    AppModule } from './app.module';
 async function bootstrap() {
   
   const app = await NestFactory.create(AppModule);

   // 构建swagger文档
   const options = new DocumentBuilder()
     .setTitle('vue3-admin')
     .setDescription('Background system based on Nest.js + Vue3 full stack development')
     .<