ResponseEntity 파라미터

sseongeun·2024년 4월 14일

스프링

목록 보기
4/13

✔️ ResponseEntity의 파라미터

1) 헤더
2) 바디 -> responseDto가 들어가는 부분(SuccessResponse/FailResponse)
3) 상태코드 -> HttpStatus의 상태코드가 들어가는 부분


2️⃣ 바디 - SuccessResponse/ FailResponse

[ 🙆🏻‍♀️ SuccessReponse ]

{
    "success": true,
    "message": "회원 정보 조회가 완료되었습니다.",
    "data": {
		    // 각 ResponseDTO
		},
    "timestamp": "2022-04-11T01:45:28Z"
}

[ 🙅🏻‍♀️ FailResponse ]

{
    "success": false, //성공여부 : 실패
    "code": "400_1",  //custom error code 
    "message": "유효하지 않은 ~입니다.", //에러 이유 메시지 
    "path": "v1/user/signup",  //에러 발생 url 
    "timestamp": "2022-04-11T01:45:28Z" //에러 발생 시간 
}

3️⃣ 상태코드 -HttpStatus 클래스에 정의되어있는 상태코드

  • HttpStatus.OK (200) : 요청이 성공적으로 처리됐을 때 사용합니다.
  • HttpStatus.CREATED (201) : 새 리소스가 성공적으로 생성됐을 때 사용합니다.
  • HttpStatus.ACCEPTED (202) : 요청이 받아들여졌지만, 처리가 완료되지 않았을 때 사용합니다.
  • HttpStatus.NO_CONTENT (204) : 요청은 성공했지만, 전달할 내용이 없을 때 사용합니다.
  • HttpStatus.BAD_REQUEST (400) : 서버가 요청을 이해하지 못했을 때 사용합니다.
    HttpStatus.UNAUTHORIZED (401) : 인증이 필요한 요청에 대해 인증이 되지 않았을 때 사용합니다.
  • HttpStatus.FORBIDDEN (403) : 서버가 요청을 거부했을 때 사용합니다.
  • HttpStatus.NOT_FOUND (404) : 요청한 리소스를 찾을 수 없을 때 사용합니다.
  • HttpStatus.INTERNAL_SERVER_ERROR (500) : 서버에 오류가 발생했을 때 사용합니다.
  • HttpStatus.SERVICE_UNAVAILABLE (503) : 서비스가 일시적으로 사용 불가능할 때 사용합니다.

... 이외에도 여러 상태코드가 존재한다.

profile
공부 기록...

0개의 댓글