공통 error code

에러 코드 문서화 예시

• 에러 코드

• 에러 메시지

• 에러 설명

• 해결 방법 또는 참고 사항

• 에러 코드: 101

• 에러 메시지: "사용자 이름이 너무 짧습니다."

• 에러 설명: 사용자 이름이 설정된 최소 길이 기준을 만족하지 못했을 때 발생합니다.

• 해결 방법: 사용자 이름을 8자 이상으로 설정해 주세요.

enum errorCode404 {
  USER_NOT_FOUND(HttpStatus.NOT_FOUND, "E1001", "유저가 없서용~");
}

도메인

1. custom server error - 1 번부터 시작
• 01: Auth 관련 Exception
• 02: User 관련 Exception
• 03: Project 관련 Exception
• 04: Profile Card 관련 Exception
• 05: ProjectJoinRequest 관련 Exception
• 06: Notification 관련 Exception
• 07: Cert 관련 Exception
• 08: Geo 관련 Exception
• 09: Matching 관련 Exception
• 10: Profile Card Like 관련 Exception
• 11: Chat 관련 Exception
• 12: Review 관련 Exception
• 13: Achievement 관련 Exception
• 14: UserAchievement 관련 Exception
 

2. 공통 error - 0 번 부터 시작
• 00 : 공통
• E999999 : 500 에러

에러 종류

예시

레퍼런스

Custom Error Code가 왜 필요했을까?

커스텀 에러 코드를 도입한 이유 이때까지 백엔드에서 예외가 발생하면 프론트엔드로 다음과 같은 응답 메시지를 보내고 있었다. // response { "message": "요청 형식이 잘못되었습니다." } 각 Http Status Code 마다 응답되는 message는 한 가지뿐이었다. 따라서 어떠한 예외가 발생하던 위의 4가지 중 하나의 메시지만 받을 수 있었다. 악의적인 사용자가 악의적인 요청을 보내 예외가 발생하는 경우 어떠한 잘못으로 인해 예외가 발생했는지 알 수 없게 하기 위해서 위처럼 메시지를 추상화하여 응답하였다. 그러나 이런 추상적인 메시지 덕분에 프론트 개발자가 개발하는데에 어려움을 겪게 되었다. 프론트 개발자가 개발 진행 중, 요청을 보냈을 때 예외가 발생하면 응답 메시지를 통해 어떤 예..

https://park-algorithm.tistory.com/entry/Custom-Error-Code-%EC%A0%81%EC%9A%A9%EA%B8%B0

알

일정이 있어서 늦게 확인 했습니다… 🙇🏻🙇🏻

api를 소비하는 입장에서 요청 → 응답 → 에러코드 확인 → 백엔드에 확인 요청 이 아닌 요청 → 응답 → 에러코드 확인 → 자체적으로 수정 → 재요청 → 정상처리 프로세스 처리를 할 수 있는 방법은 없을까?

HTTP 상태 코드 - HTTP | MDN

HTTP 응답 상태 코드는 특정 HTTP 요청이 성공적으로 완료되었는지 알려줍니다. 응답은 5개의 그룹으로 나누어집니다: 정보를 제공하는 응답, 성공적인 응답, 리다이렉트, 클라이언트 에러, 그리고 서버 에러. 상태 코드는 section 10 of RFC 2616에 정의되어 있습니다.

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

• 빈도가 높은 HttpStatus

• 오류코드 명세 를 정의한다면 아래와 같은 방식으로 정의할 수 있지 않을까?
• 오류 타입(type)
• invalid_request_error(4xx)
• auth_error (401, 403)
• api_error (500)
• 오류 코드(code)
• 에러가 발생할 수 있는 구간을 정의하고 이를 단어로 정의
• 오류 메시지(message)
• 오류 코드에 대한 보다 상세한 내용을 서술
• 오류 원인(param)
• 요청 시 원인이 되는 파라미터를 전달
• 비즈니스 처리시 원인이 되는 파라미터는 응답으로서 노출할 대상이 아님

에러 응답 타입 - 상세한 명세를 제시하는 타입

public class ErrorResponse {
  private final String type; // 오류에 대한 타입(카테고리)을 정의 (api_error, invalid _request_error...)
  private final String code; // 보다 디테일한(도메인 관련) 오류코드를 정의 (invalid_parameter)
  private final String message; // 오류코드에 대한 보다 상세한 메시지를 정의
  private final String param; // 오류가 발생한 원인에 대한 파라미터를 전달
  private final String docUrl; // code에 대한 보다 자세한 정보를 알 수 있는 URL
  private final String requestLogUrl; // 요즘 트랜드한 서비스에서는 요청에 대한 관리 페이지를 제공(에러사유에 대한 해법 제공)

	//...
}

path가 없는 경우

{
  "error": {
    "code": "resource_missing", // 예시 404 not found에 대한 응답 코드
    "doc_url": "{github wiki에 정의하여 url을 담아 보내주는 것도 좋을 듯}",
    "message": "No such transaction ", // api resource(path)가 없는 경우
    "type": "invalid_request_error"
  }
}

400 Bad Request 특정 값에 대한 오류가 발생하는 경우

{
  "error": {
    "message": "{value} is not a valid phone number",
    "message_code": "invalid_phone_number",
    "param": "phone",
    "request_log_url": "{요청 및 응답 명세를 확인할 수 있는 url}",
    "type": "invalid_request_error"
  }
}

500 internal server exception

{
  "error": {
    "message": "An unknown error occurred",
    "request_log_url": "{요청 및 응답 값을 확인할 수 있는 url}",
    "type": "api_error"
  }
}