第三步：加入Swagger文档

第一步：基于node创建一个Nest.js项目第二步：创建写接口的模块，建立moogodb数据库连接，写添加与查询接口

• 注：不要关心注释代码，那是属于后面功能的区域。因为随着代码体量加大，功能不再明确，只需按照步骤并参考效果图，把关键代码写入即可，所以下只写关键代码，具体请看效果图。项目地址

1 引入并定义Swagger文档

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

～/src/main.js

// Swagger 文档  https://docs.nestjs.cn/9/recipes?id=swagger
// npm install --save @nestjs/swagger swagger-ui-express
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

  // Swagger 文档配置
  const options = new DocumentBuilder()
    .setTitle('Cats example') // 标题
    .setDescription('The cats API description') // 描述
    .setVersion('1.0') // 版本号
    .addTag('cats') // 标签
    .build();
  const document = SwaggerModule.createDocument(app, options);
  SwaggerModule.setup('api', app, document); // 接口文档访问路径 127.0.0.1:32000/api

效果图

• 接着访问127.0.0.1:32000/api即可看到Swagger文档
  

  效果图

2 在接口处添加标签，请求参数/响应参数文档字段描述

2.1 添加文档标签与请求默认参数

import { ApiTags, ApiQuery} from '@nestjs/swagger';

  // Swagger标签
  @ApiTags('有Swagger文档Post')
  // 请求方式：Post， 请求路径：/user-copy/addCopy
  @Post('addCopy')
  // @Body() 装饰器
  async addDataCopy(@Body() body) {
    // create 插入一条数据，直接将接收到的body参数插入
    const data = await this.userModel.create(body)
    if (data) {
      return { code: 200, data: null, message: "操作成功" }
    }
  }

  // Swagger标签
  @ApiTags('有Swagger文档GET')
  // 针对Get请求 使其可以在接口文档模拟传参
  @ApiQuery({ name: 'user_name' })
  // 请求方式：Get， 请求路径：/user-copy/findCopy
  @Get('findCopy')
  // 响应参数文档
  // @ApiCreatedResponse({ description: '', type: userResponses })
  // @Query() 装饰器
  async findDataCopy(@Query() query) {
    // find  查询指定数据
    const data = await this.userModel.find({ user_name: query.user_name })
    // 模糊查询
    // $regex 是 MongoDB 查询操作符，用于指定正则表达式进行匹配。$options: 'i' 表示不区分大小写，即忽略关键字的大小写。
    // const data = await this.userModel.find({ user_name: { $regex: query.user_name, $options: 'i' } })

    return { code: 200, data: data, message: "操作成功" }
  }

效果图

效果图

2.2 添加请求参数/响应参数文档字段描述

2.2.1 创建文档描述文件user_copy.swagger.validator.ts

～/src/user_copy/user_copy.swagger.validator.ts

// Swagger 文档配置 https://docs.nestjs.cn/8/recipes?id=swagger
import { ApiProperty } from '@nestjs/swagger';
// 请求参数验证(自动验证) https://docs.nestjs.cn/8/techniques?id=%e8%87%aa%e5%8a%a8%e9%aa%8c%e8%af%81
// import { IsNotEmpty } from 'class-validator'

export class userResponses {
  // 接口文档展示信息 description 示例值  example 字段描述  required：true 则展示为必填
  @ApiProperty({ description: '', example: '账号', required: false })
  user_name: string;

  @ApiProperty({ description: '', example: '密码', required: false })
  password: string;

  @ApiProperty({ description: '', example: '年龄', required: false })
  age: string;

  @ApiProperty({ description: '', example: '性别', required: false })
  sex: string;

  @ApiProperty({ description: '', example: '时间', required: false })
  date: string;
}

2.2.2 引入并使用描述文档

～/src/user_copy/user_copy.controller.ts

import { ApiTags, ApiQuery, ApiCreatedResponse } from '@nestjs/swagger';
import { userResponses } from './user_copy.swagger.validator'

  // Swagger标签
  @ApiTags('有Swagger文档')
  // 请求方式：Post， 请求路径：/user-copy/addCopy
  @Post('addCopy')
  // @Body() 装饰器
  async addDataCopy(@Body() body: userResponses) {
    // create 插入一条数据，直接将接收到的body参数插入
    const data = await this.userModel.create(body)
    if (data) {
      return { code: 200, data: null, message: "操作成功" }
    }
  }

  // Swagger标签
  @ApiTags('有Swagger文档')
  // 针对Get请求 使其可以在接口文档模拟传参
  @ApiQuery({ name: 'user_name' })
  // 请求方式：Get， 请求路径：/user-copy/findCopy
  @Get('findCopy')
  // 响应参数文档
  @ApiCreatedResponse({ description: '', type: userResponses })
  // @Query() 装饰器
  async findDataCopy(@Query() query) {
    // find  查询指定数据
    const data = await this.userModel.find({ user_name: query.user_name })
    // 模糊查询
    // $regex 是 MongoDB 查询操作符，用于指定正则表达式进行匹配。$options: 'i' 表示不区分大小写，即忽略关键字的大小写。
    // const data = await this.userModel.find({ user_name: { $regex: query.user_name, $options: 'i' } })

    return { code: 200, data: data, message: "操作成功" }
  }

效果图

效果图

效果图