NestJS로 효율적인 백엔드 개발하기 (03) - 컨트롤러 사용하기

컨트롤러(controller)란?

NestJS의 컨트롤러는 HTTP 요청을 받아 처리할 메서드로 연결하고, 서비스의 실행 결과를 클라이언트에게 돌려주는 역할을 한다. URL 경로와 HTTP 메서드를 매핑해 애플리케이션의 라우팅을 담당하는 핵심 요소이다.

---

시작 전 셋팅

nest g resource users

시작 전 위의 명령어를 실행하여 users를 만들어준다.

---

@Get

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

@Controller('users')
export class UsersController {
  @Get()
  findUser(): string {
    return 'find user page';
  }
}

@Controller('users')를 통해서 localhost:3000/users 로 경로를 만들고 @Get()을 통해서 / 경로로 접속할 경우 find user page 의 문자열을 띄운다. Controller 의 () 안에는 요청 라우팅 경로를 지정할 수 있고, 없을 경우에는 / 로 인식하게 된다.

• localhost:3000/usres -> @Controller('users')
• localhost:3000 -> @Controller()

---

Request 객체

NestJS는 Express를 사용하고 있기 때문에 Reqeust객체를 사용할 수 있다. @Req() 데코레이터를 사용하면 된다.

import { Controller, Get, Req } from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Get('req-headers')
  reqTest(@Req() req: Request) {
    console.log(req);
    return req.headers;
  }
}

---

@Query()

@Query()는 HTTP 요청의 Query String 파라미터를 컨트롤러 메서드의 인자로 주입하기 위한 데코레이터이다. URL 뒤에 ?key=value 형태로 붙는 값을 자동으로 추출해 개발자가 바로 사용할 수 있도록 도와준다.

import { Controller, Get, Query, Req } from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Get('query-test')
  queryTest(@Query('name') name: string, @Query('age') age: string) {
    return { name, age };
  }
}

---

@Param()

@Param()은 HTTP 요청의 URL 경로(Route Parameter)에 포함된 값을 컨트롤러 메서드의 인자로 주입할 때 사용하는 데코레이터이다.

import { Controller, Get, Param, Query, Req } from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Get('param-test/:id/name/:name/age/:age')
  paramTest(@Param() params) {
    return params;
  }
}

---

@Post() 와 @Body()

import { Body, Controller, Get, Param, Post, Query, Req } from '@nestjs/common';
import { BodyTestDto } from './dto/body-test-dto/body-test-dto';

@Controller('users')
export class UsersController {
  @Post('body-test')
  bodyTest(@Body() bodyTestDto: BodyTestDto) {
    return bodyTestDto;
  }
}

---

참고

https://docs.nestjs.com/controllers

Documentation | NestJS - A progressive Node.js framework

https://codegear.tistory.com/58

NestJS - 05.컨트롤러 만들기