Node.js/npm

[Node.js] http-status-codes란 무엇인가?

장일규 2022. 5. 8. 18:02

http-status-codes

 

이 모듈은 HTTP 통신에서 서버가 클라이언트에게 전달하는 응답의 상태 코드를 나타내는 상수들을 제공한다.

 

http-status-codes를 사용하지 않을 경우

 다음과 같이 status값에 리터럴한 정수 값으로 대입을 해야한다.

 

res.status(200); // 성공
res.status(400); // 클라이언트 오류
res.status(500); // 실패

 

위에 상수로 선언을 해도 정상적인 잘 돌아가는 로직이다.

But....

상수로 정수 값을 할당하면 의미를 명확하게 전달하기 어렵다

 

설치

$ npm install http-status-codes --save

사용법

 

1. require 함수를 사용하여 http-status-codes 모듈을 가져온다.

const { StatusCodes } = require('http-status-codes');

2. 응답 상태 코드를 선언한다.

res.status(StatusCodes.OK); // 200
res.status(StatusCodes.CREATED); // 201
res.status(StatusCodes.NOT_FOUND); // 404

http-status-codes라이브러리를 사용하면 위와 같이 가독성이 향상이 된다.

enum으로 사용하여 응답 상태 코드를 정의하는 것을 추천!!

 

reference

http-status-codes