Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ErrorCode 및 SuccessCode 사용 #9

Open
tkv00 opened this issue Oct 13, 2024 · 0 comments
Open

ErrorCode 및 SuccessCode 사용 #9

tkv00 opened this issue Oct 13, 2024 · 0 comments
Labels
✨기능 Improvements or additions to documentation

Comments

@tkv00
Copy link
Contributor

tkv00 commented Oct 13, 2024

구현이유

  • 협업과정에서 FE팀에서 API요청 시 오류 내용에 대해 상세 정보를 확인가능할 수 있도록 하기 위해 구현
  • customException을 통해 서버측에서도 상세한 에러 메세지를 받을 수 있도록 한다.

사용방법

 //성공메시지 리턴
        return new ResponseEntity<>(new ReturnCodeDTO(200, SuccessCode.SUCCESS_INCOME.getMessage()),
                HttpStatusCode.valueOf(SuccessCode.SUCCESS_INCOME.getStatus()));
  • controller계층에서 구현한다.
  • 다음과 같이 ResponseEntity형태로 ReturnCodeDTO클래스를 전송한다.
  • constants폴더의 SuccessCode ErrorCode enum클래스의 메세지 및 상태를 사용한다.

사용시 주의사항

  1. 협업자는 코드의 일관성을 위해 공통된 성공코드 및 에러코드를 전송해야한다.
  2. 성공코드 및 에러코드의 추가 메세지 및 상태는 해당 클래스에 추가한다.
  3. 클라이언트가 에러발생 시 에러내용 파악을 위해 메세지와 상태를 필수적으로 전송한다.

추가 구현

  • 에러메세지에 대해 상세내용 전송을 구현해야함.
@tkv00 tkv00 added the ✨기능 Improvements or additions to documentation label Oct 13, 2024
@tkv00 tkv00 pinned this issue Nov 11, 2024
@pjs1710 pjs1710 unpinned this issue Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨기능 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant