第四步:加入請(qǐng)求參數(shù)校驗(yàn)

第一步:創(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ā)生什么
    效果圖

    效果圖
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末坡锡,一起剝皮案震驚了整個(gè)濱河市蓬网,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌鹉勒,老刑警劉巖帆锋,帶你破解...
    沈念sama閱讀 206,311評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異禽额,居然都是意外死亡锯厢,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門脯倒,熙熙樓的掌柜王于貴愁眉苦臉地迎上來实辑,“玉大人,你說我怎么就攤上這事藻丢♂悴ぃ” “怎么了?”我有些...
    開封第一講書人閱讀 152,671評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵郁岩,是天一觀的道長婿奔。 經(jīng)常有香客問我,道長问慎,這世上最難降的妖魔是什么萍摊? 我笑而不...
    開封第一講書人閱讀 55,252評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮如叼,結(jié)果婚禮上冰木,老公的妹妹穿的比我還像新娘。我一直安慰自己笼恰,他們只是感情好踊沸,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著社证,像睡著了一般逼龟。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上追葡,一...
    開封第一講書人閱讀 49,031評(píng)論 1 285
  • 那天腺律,我揣著相機(jī)與錄音,去河邊找鬼宜肉。 笑死匀钧,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的谬返。 我是一名探鬼主播之斯,決...
    沈念sama閱讀 38,340評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼遣铝!你這毒婦竟也來了佑刷?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,973評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤翰蠢,失蹤者是張志新(化名)和其女友劉穎项乒,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體梁沧,經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡檀何,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了廷支。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片频鉴。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖恋拍,靈堂內(nèi)的尸體忽然破棺而出垛孔,到底是詐尸還是另有隱情,我是刑警寧澤施敢,帶...
    沈念sama閱讀 33,701評(píng)論 4 323
  • 正文 年R本政府宣布周荐,位于F島的核電站狭莱,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏概作。R本人自食惡果不足惜腋妙,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望讯榕。 院中可真熱鬧骤素,春花似錦、人聲如沸愚屁。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽霎槐。三九已至送浊,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間栽燕,已是汗流浹背罕袋。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留碍岔,地道東北人浴讯。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像蔼啦,于是被迫代替她去往敵國和親榆纽。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容