第一步:創(chuàng)建一個(gè)基礎(chǔ)項(xiàng)目
第二步:創(chuàng)建寫接口的模塊源葫,建立moogodb數(shù)據(jù)庫連接鸭叙,寫添加與查詢接口
第三步:加入Swagger文檔
-
注:不要關(guān)心注釋代碼,那是屬于后面功能的區(qū)域么翰。因?yàn)殡S著代碼體量加大,功能不再明確,只需按照步驟并參考效果圖姐呐,把關(guān)鍵代碼寫入即可,所以下只寫關(guān)鍵代碼典蝌,具體請(qǐng)看效果圖曙砂。
項(xiàng)目地址
1 引入管道,并全局啟用
npm i --save class-validator class-transformer
~/src/main.ts
import { ValidationPipe } from '@nestjs/common';
// 全局掛載管道
app.useGlobalPipes(new ValidationPipe());
2 針對(duì)請(qǐng)求參數(shù)文檔user_copy.swagger.validator.ts
文件內(nèi)的代碼修改
- 加入
@IsNotEmpty()
即可開啟請(qǐng)求參數(shù)校驗(yàn)
~/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 userResponsesValidator {
// 接口文檔展示信息 description 示例值 example 字段描述 required:true 則展示為必填
@ApiProperty({ description: '', example: '賬號(hào)', required: true })
@IsNotEmpty({message:'賬號(hào)必填'})
user_name: string;
@ApiProperty({ description: '', example: '密碼', required: true })
@IsNotEmpty({message:'密碼必填'})
password: string;
@ApiProperty({ description: '', example: '年齡', required: false })
age: string;
@ApiProperty({ description: '', example: '性別', required: false })
sex: string;
@ApiProperty({ description: '', example: '時(shí)間', required: false })
date: string;
}
export class GetRequestDto {
@ApiProperty({ description: '', example: '賬號(hào)', required: true })
@IsNotEmpty({message:'賬號(hào)必填'})
user_name: string;
}
3 引入并使用
~/src/user_copy/user_copy.controller.ts
import { userResponses, userResponsesValidator, GetRequestDto } from './user_copy.swagger.validator'
// ----------------------- 以下示例接口將加入Swagger文檔骏掀,開啟請(qǐng)求參數(shù)必填校驗(yàn)-----------------------
// Swagger標(biāo)簽
@ApiTags('有Swagger文檔/開啟請(qǐng)求參數(shù)校驗(yàn)')
// 請(qǐng)求方式:Post鸠澈, 請(qǐng)求路徑:/user-copy/addValidator
@Post('addValidator')
// @Body() 裝飾器
async addDataValidator(@Body() body: userResponsesValidator) {
// 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文檔/開啟請(qǐng)求參數(shù)校驗(yàn)')
// 針對(duì)Get請(qǐng)求 使其可以在接口文檔模擬傳參
@ApiQuery({ name: 'user_name' })
// 請(qǐng)求方式:Get截驮, 請(qǐng)求路徑:/user-copy/findValidator
@Get('findValidator')
// 響應(yīng)參數(shù)文檔
@ApiCreatedResponse({ description: '', type: userResponses })
// @Query() 裝飾器
async findDataValidator(@Query() query: GetRequestDto) {
// 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: "操作成功" }
}
4 測試攔截效果
-
現(xiàn)在賬號(hào)/密碼字段已加入必填校驗(yàn),那么試試不傳會(huì)發(fā)生什么