[Nest.js] API 설계 - 요청, 응답 객체 (Request, Response Object)

 

 

🚀 요청, 응답 객체

    🔽  요청 객체(Request Object)

`Client`가 보낸 `Request(요청)`에는 세부 정보를 필요로 할 때가 있을 수 있는 것이에요. 예를 들면 `Session 정보`, `Request Header 정보` 등이에요. `Nest.js`에서는 `Express.js`나 `Fastify`의 요청 객체에 접근할 수 있도록 해 주는 것이에요. `@Res()` 처럼 Handler의 시그니쳐에 Decorator를 추가하여 `Nest.js`에 주입하도록 선언하여 요청 객체에 접근할 수 있는 것이에요.

 

예시 코드

만약 `TypeScript`를 이용할 경우 위의 예제처럼 `Express.js`의 `Request`를 이용하기 위해 `@types/express` Package를 설치 해야 되는 것이에요.

`Request(요청)` 객체는 Query 문자열, 매개 변수, HTTP Header, HTTP Body에 대한 속성을 가지고 있는 것이에요.

`Nest.js`에는 이 속성을 편리하게 가져올 수 있도록 `@Body()`, `@Query()` 같은 Decorator를 제공하는 것이에요.

 

 

HTTP 관련 Decorator

 

 

 

 

    🔽  응답 객체 (Response Object)

`Express.js`, `Fastify` 별 응답을 조작할 수 있는 것이에요. `{Method Name}(@Res() response)`와 같이 `@Res()`를 Method 시그니쳐에 추가하면 되는 것이에요.

💡 참고 사항
Method 시그니쳐

컴퓨터 과학에서 함수 서명 혹은 메서드 서명은 컴파일러가 함수를 구분하기 위한 구성요소를 말한다. 프로그래밍 언어마다 시그니쳐를 구성하는 요소가 다르지만 대체적으로 아래의 요소가 포함되어 있다.

• 함수의 이름
• 매개변수(Parameter)의 개수
• (옵셔널) 매개변수의 자료형
• (옵셔널) 반환하는 값의 자료형

옵셔널로 표시된 항목들은 자료형이 없는 동적 언어에서는 해당사항이 없다. 만약 두 함수의 이름, 매개변수의 개수, 그 타입이 모두 같다면 이 두 함수의 시그니처는 같다고 할 수 있다.

반응형

 

이렇게 접근하면 `Express/Fastify`의 기본 `Response` Method를 이용할 수 있는 것이에요.

예를 들어 `Express.js`를 이용한다면 `response.status(200).send()`와 같이 HTTP Status Code 200을 보낼 수 있는 것이에요.

`Nest.js`에서는 `@Res()`와 `Response()`를 제공하는데, `@Res()`는 `@Response`에 별칭인 것이에요.

두 개 모두 기본 HHTP Plaform `Response` 객체 Interface를 직접 노출하는 것이에요.

만약 Method Handler에서 `@Res()`, `@Response()`를 이용했다면 `Nest.js`를 특정 `Library Mode`로 사용하겠다는 것이기 때문에 반드시 `Response(응답)` 관리를 해주어야 하는 것이에요.

이 경우 `res.json()`, `res.send()`를 통해 직접적인 응답을 주지 않으면 Server가 Down 되어 버리는 불편한 상황이 생겨 버리는 것이에요.