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 控制器同級創(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ā)者工具中可以看到請求的響應(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 對象或數(shù)組時(shí), 它會(huì)自動(dòng)轉(zhuǎn)換為 JSON。當(dāng)返回字符串, Nest 將只發(fā)送一個(gè)字符串而不嘗試解析它。

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

Nest 以同樣的方式提供了其他的裝飾器來處理不同類型的 HTTP請求 - @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 請求上下文對象的映射關(guān)系:

image.png

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲(chǔ)服務(wù)。

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

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