2、Nest.js 创建基本的REST控制器

Nest.js 6.0 必看

使用 Nest CLI 生成一个基本的控制器

使用 CLI 提供的 generate (别名: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 会自动在 src 目录下创建一个 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 控制器同级创建一个 interfaces 目录,并定义一个 User 接口:

src/users/interfaces/user.interface.ts

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

现在给这个控制器添加一个获取所有用户的 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 语法,并返回一个泛型 Promise<User[]>。
此时使用 npm run start:dev 启动项目,并访问 http://127.0.0.1:3000/users,在 chrome 开发者工具中可以看到请求的响应信息。

image.png

有三个比较重要的地方:

Status Code: 200 OK    // 响应状态代码在默认情况下总是 200

Content-Type: application/json; charset=utf-8  // 当返回 JavaScript 对象或数组时, 它会自动转换为 JSON。当返回字符串, Nest 将只发送一个字符串而不尝试解析它。

X-Powered-By: Express  // 底层服务使用 Express

Nest 以同样的方式提供了其他的装饰器来处理不同类型的 HTTP请求 - @Put(),@Delete(),@Patch(),@Options(),@Head() 和 @All()。

    @Post()
    async create() {
        // TODO:创建新用户
    }

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

    @Delete()
    async remove() {
        // TODO:删除已有用户
    }

所有这些装饰器都从 @nestjs/common 包中导出:

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

带参数的路由

和 Express 带参数的路由一样,只需要在 @Get() 装饰器中传入 " : + [ 参数名 ] ",新增一个 findOne Action:


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

现在访问 http://127.0.0.1:3000/users/44 将得到以下输出:

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

下面这个表就是 Nest 装饰器和 HTTP 请求上下文对象的映射关系:

image.png

上一篇:1、Nest.js 项目搭建
下一篇:3、Nest.js 中的依赖注入与提供者

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容