2. Node 프로젝트 가계부 만들기 (오류코드 생성)

2021. 5. 25. 10:50프로젝트/가계부 - 초기 개발

REST API를 사용시 상태 확인을 Status Code로 확인을 한다.

 

http 설명

https://developer.mozilla.org/ko/docs/Web/HTTP/Status

https://evan-moon.github.io/2020/03/15/about-http-status-code/   

 

이 프로젝트에선 200, 401, 403, 404, 409를 사용한다.

 

에러 코드 사용 방법은 lib 폴더에 error.js파일안에 함수로 만들어 간단하게 만들 것이다.

error.js 내용은 

error.js

module.exports = {
  errorCode:(res, code, msg, data)=>{
    let status = 'fail'
    if(code === 200){
      status = 'ok'
    }
    let box = {code, msg, status, data}
    res.status(code).json(box)
  }
}

errorCode 파라미터 설명

- res : 프론트에게 응답을 위해 파라미터로 받는다.

- code : 상태코드를 받는다.

- msg : 오류발생시, 프론트에서 오류를 상세히 알수있게 메시지를 보내주기 위해 받는다.

- data : 프론트에서 요청한 데이터가 있을시 데이터를 보내주기 위해 받는다.

let status = 'fail'
    if(code === 200){
      status = 'ok'
    }

status = 'ok'를 넣은 이유

프론트에서 에러 여부를 확인하기 위해서 넣어주었다. 

res.status(code).json(box)

res.status(code)로 상태코드값이 보내지면서 같이, json형식으로 code, msg, status, data를 보내준다.

 

사용방법

사용법

 

// 에러코드 함수를 불러온다
const err = require('./lib/error').errorCode 

// 에러코드 함수에 파라미터값을 넣어준다, 전송하는 데이터가 없기 때문에 data부분은 생략
err(res, 401,'로그인 후 이용해주세요.')

// 에러코드 함수에 파라미터값을 넣어준다, 
// 오류가 아니고 전송하는 데이터가 존재하기 때문에 msg부분은 '' 입력
err(res, 200, '', token)

 

728x90
반응형