2夯膀、Nest.js 創(chuàng)建基本的REST控制器

Nest.js 6.0 必看

使用 Nest CLI 生成一個(gè)基本的控制器

使用 CLI 提供的 generate (別名:g) 命令生成一個(gè)基本的 users Controller (別名: co):

$ nest g co users
CREATE /src/users/users.controller.spec.ts (478 bytes)
CREATE /src/users/users.controller.ts (99 bytes)
UPDATE /src/app.module.ts (658 bytes)

Nest CLI 會(huì)自動(dòng)在 src 目錄下創(chuàng)建一個(gè) users 目錄作為 users 模塊捆昏,并且在 app.module.ts 中注入該控制器:

src/app.module.ts

import { Module } from '@nestjs/common';
import { UsersController } from './users/users.controller';

@Module({
  controllers: [UsersController],
})
export class ApplicationModule {}

src/users/user.controller.ts

import { Controller } from '@nestjs/common';

@Controller('users')
export class UsersController {}

控制器必須使用 @Controller() 裝飾器修飾缤剧,傳入的 'users' 就是該控制器中所有 action 的路由前綴学辱。

去中心化的路由

首先在 user 控制器同級(jí)創(chuàng)建一個(gè) interfaces 目錄,并定義一個(gè) User 接口:

src/users/interfaces/user.interface.ts

export interface User {
    readonly id: number;
    readonly name: string;
    readonly age: number;
}

現(xiàn)在給這個(gè)控制器添加一個(gè)獲取所有用戶的 action:

import { Controller, Get } from '@nestjs/common';
import { User } from './interfaces/user.interface';

@Controller('users')
export class UsersController {
    @Get()
    async findAll(): Promise<User[]> {

        return [{
            id: 1,
            name: '小明',
            age: 18
        }];
    }
}

這里使用 Async / Await 語法膝但,并返回一個(gè)泛型 Promise<User[]>。
此時(shí)使用 npm run start:dev 啟動(dòng)項(xiàng)目谤草,并訪問 http://127.0.0.1:3000/users跟束,在 chrome 開發(fā)者工具中可以看到請(qǐng)求的響應(yīng)信息。

image.png

有三個(gè)比較重要的地方:

Status Code: 200 OK    // 響應(yīng)狀態(tài)代碼在默認(rèn)情況下總是 200

Content-Type: application/json; charset=utf-8  // 當(dāng)返回 JavaScript 對(duì)象或數(shù)組時(shí), 它會(huì)自動(dòng)轉(zhuǎn)換為 JSON丑孩。當(dāng)返回字符串, Nest 將只發(fā)送一個(gè)字符串而不嘗試解析它冀宴。

X-Powered-By: Express  // 底層服務(wù)使用 Express

Nest 以同樣的方式提供了其他的裝飾器來處理不同類型的 HTTP請(qǐng)求 - @Put(),@Delete()温学,@Patch()略贮,@Options(),@Head() 和 @All()。

    @Post()
    async create() {
        // TODO:創(chuàng)建新用戶
    }

    @Put()
    async edit() {
        // TODO: 修改用戶信息
    }

    @Delete()
    async remove() {
        // TODO:刪除已有用戶
    }

所有這些裝飾器都從 @nestjs/common 包中導(dǎo)出:

import { Controller, Param, Get, Post, Put, Delete } from '@nestjs/common';

帶參數(shù)的路由

和 Express 帶參數(shù)的路由一樣逃延,只需要在 @Get() 裝飾器中傳入 " : + [ 參數(shù)名 ] "览妖,新增一個(gè) findOne Action:


    @Get(':id')
    async findOne(@Param() params): Promise<User> {
        
        return {
            id: params.id,
            name: '小明',
            age: 18
        };
    }

現(xiàn)在訪問 http://127.0.0.1:3000/users/44 將得到以下輸出:

{"id":"44","name":"小明","age":18}

下面這個(gè)表就是 Nest 裝飾器和 HTTP 請(qǐng)求上下文對(duì)象的映射關(guān)系:

image.png

上一篇:1、Nest.js 項(xiàng)目搭建
下一篇:3揽祥、Nest.js 中的依賴注入與提供者

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末讽膏,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子拄丰,更是在濱河造成了極大的恐慌府树,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,639評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件料按,死亡現(xiàn)場(chǎng)離奇詭異奄侠,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)载矿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,277評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門垄潮,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人恢准,你說我怎么就攤上這事魂挂。” “怎么了馁筐?”我有些...
    開封第一講書人閱讀 157,221評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵涂召,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我敏沉,道長(zhǎng)果正,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,474評(píng)論 1 283
  • 正文 為了忘掉前任盟迟,我火速辦了婚禮秋泳,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘攒菠。我一直安慰自己迫皱,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,570評(píng)論 6 386
  • 文/花漫 我一把揭開白布辖众。 她就那樣靜靜地躺著卓起,像睡著了一般。 火紅的嫁衣襯著肌膚如雪凹炸。 梳的紋絲不亂的頭發(fā)上戏阅,一...
    開封第一講書人閱讀 49,816評(píng)論 1 290
  • 那天,我揣著相機(jī)與錄音啤它,去河邊找鬼奕筐。 笑死舱痘,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的离赫。 我是一名探鬼主播芭逝,決...
    沈念sama閱讀 38,957評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼笆怠!你這毒婦竟也來了铝耻?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,718評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤蹬刷,失蹤者是張志新(化名)和其女友劉穎瓢捉,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體办成,經(jīng)...
    沈念sama閱讀 44,176評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡泡态,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,511評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了迂卢。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片某弦。...
    茶點(diǎn)故事閱讀 38,646評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖而克,靈堂內(nèi)的尸體忽然破棺而出靶壮,到底是詐尸還是另有隱情,我是刑警寧澤员萍,帶...
    沈念sama閱讀 34,322評(píng)論 4 330
  • 正文 年R本政府宣布绪商,位于F島的核電站峦椰,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜自沧,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,934評(píng)論 3 313
  • 文/蒙蒙 一嫉拐、第九天 我趴在偏房一處隱蔽的房頂上張望趟薄。 院中可真熱鬧贱枣,春花似錦、人聲如沸日麸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,755評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽代箭。三九已至辕录,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間梢卸,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,987評(píng)論 1 266
  • 我被黑心中介騙來泰國(guó)打工副女, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留蛤高,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,358評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像戴陡,于是被迫代替她去往敵國(guó)和親塞绿。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,514評(píng)論 2 348

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

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理恤批,服務(wù)發(fā)現(xiàn)异吻,斷路器,智...
    卡卡羅2017閱讀 134,633評(píng)論 18 139
  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 171,777評(píng)論 25 707
  • 作者:鄭毅 地點(diǎn):臺(tái)北一路 時(shí)間:2017.3.27 22:30 【發(fā)現(xiàn)自己 第10天】 前三天處在一個(gè)平乏的狀態(tài)...
    zy一往直前閱讀 226評(píng)論 0 0
  • 剛剛一口氣看完了《阿彌陀佛么么噠》喜庞,曾在學(xué)校的路邊書攤看到過诀浪,也曾在批發(fā)市場(chǎng)看到過,亦曾在網(wǎng)上看到過延都,一直沒有去讀...
    紫繭閱讀 371評(píng)論 5 4
  • 首先是抗戰(zhàn)劇的投資普遍偏少雷猪,多為小成本制作,真正投入到電視劇制作中的錢晰房,可能不到投資的百分之三十求摇。所以不光編劇拿錢...
    我愛徐太太閱讀 483評(píng)論 0 0