第一步：基于node創(chuàng)建一個(gè)Nest.js項(xiàng)目
第二步：創(chuàng)建寫接口的模塊洪己，建立moogodb數(shù)據(jù)庫連接沃琅，寫添加與查詢接口

• 注：不要關(guān)心注釋代碼澈歉，那是屬于后面功能的區(qū)域悟衩。因?yàn)殡S著代碼體量加大潮饱，功能不再明確，只需按照步驟并參考效果圖换帜，把關(guān)鍵代碼寫入即可，所以下只寫關(guān)鍵代碼禾蚕，具體請(qǐng)看效果圖。
  項(xiàng)目地址

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') // 標(biāo)題
    .setDescription('The cats API description') // 描述
    .setVersion('1.0') // 版本號(hào)
    .addTag('cats') // 標(biāo)簽
    .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 在接口處添加標(biāo)簽躁愿，請(qǐng)求參數(shù)/響應(yīng)參數(shù)文檔字段描述

2.1 添加文檔標(biāo)簽與請(qǐng)求默認(rèn)參數(shù)

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

  // Swagger標(biāo)簽
  @ApiTags('有Swagger文檔Post')
  // 請(qǐng)求方式：Post峡眶， 請(qǐng)求路徑：/user-copy/addCopy
  @Post('addCopy')
  // @Body() 裝飾器
  async addDataCopy(@Body() body) {
    // create 插入一條數(shù)據(jù)狮暑，直接將接收到的body參數(shù)插入
    const data = await this.userModel.create(body)
    if (data) {
      return { code: 200, data: null, message: "操作成功" }
    }
  }

  // Swagger標(biāo)簽
  @ApiTags('有Swagger文檔GET')
  // 針對(duì)Get請(qǐng)求 使其可以在接口文檔模擬傳參
  @ApiQuery({ name: 'user_name' })
  // 請(qǐng)求方式：Get脖旱， 請(qǐng)求路徑：/user-copy/findCopy
  @Get('findCopy')
  // 響應(yīng)參數(shù)文檔
  // @ApiCreatedResponse({ description: '', type: userResponses })
  // @Query() 裝飾器
  async findDataCopy(@Query() query) {
    // find  查詢指定數(shù)據(jù)
    const data = await this.userModel.find({ user_name: query.user_name })
    // 模糊查詢
    // $regex 是 MongoDB 查詢操作符介蛉，用于指定正則表達(dá)式進(jìn)行匹配萌庆。$options: 'i' 表示不區(qū)分大小寫，即忽略關(guān)鍵字的大小寫币旧。
    // const data = await this.userModel.find({ user_name: { $regex: query.user_name, $options: 'i' } })

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

效果圖

效果圖

2.2 添加請(qǐng)求參數(shù)/響應(yīng)參數(shù)文檔字段描述

2.2.1 創(chuàng)建文檔描述文件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';
// 請(qǐng)求參數(shù)驗(yàn)證（自動(dòng)驗(yàn)證） 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: '賬號(hào)', 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: '時(shí)間', 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標(biāo)簽
  @ApiTags('有Swagger文檔')
  // 請(qǐng)求方式：Post践险， 請(qǐng)求路徑：/user-copy/addCopy
  @Post('addCopy')
  // @Body() 裝飾器
  async addDataCopy(@Body() body: userResponses) {
    // create 插入一條數(shù)據(jù)，直接將接收到的body參數(shù)插入
    const data = await this.userModel.create(body)
    if (data) {
      return { code: 200, data: null, message: "操作成功" }
    }
  }

  // Swagger標(biāo)簽
  @ApiTags('有Swagger文檔')
  // 針對(duì)Get請(qǐng)求 使其可以在接口文檔模擬傳參
  @ApiQuery({ name: 'user_name' })
  // 請(qǐng)求方式：Get佳恬， 請(qǐng)求路徑：/user-copy/findCopy
  @Get('findCopy')
  // 響應(yīng)參數(shù)文檔
  @ApiCreatedResponse({ description: '', type: userResponses })
  // @Query() 裝飾器
  async findDataCopy(@Query() query) {
    // find  查詢指定數(shù)據(jù)
    const data = await this.userModel.find({ user_name: query.user_name })
    // 模糊查詢
    // $regex 是 MongoDB 查詢操作符捏境，用于指定正則表達(dá)式進(jìn)行匹配。$options: 'i' 表示不區(qū)分大小寫毁葱，即忽略關(guān)鍵字的大小寫垫言。
    // const data = await this.userModel.find({ user_name: { $regex: query.user_name, $options: 'i' } })

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

效果圖

效果圖

效果圖