Spring 프로젝트 API 공통 response 처리 과정 개발 기록

• HTTP API(REST API)를 개발하는 경우, 규격에 맞는 응답 처리를 구현해야 한다. 이때, ResponseEntity 혹은 HttpEntity를 사용하면, HTTP status code를 설정한 response 반환이 가능하다.

• ResponseEntity로 감싸지 않고, 객체를 반환해도 HttpMessageConverter에 의해 json 형식으로 반환이 가능하지만, status code는 200 고정이라는 점을 유념해야 한다.

• API 응답을 일관성 있게 전달하기 위해, 공통 클래스를 개발하여 사용한다. 이를 통해 클라이언트는 success나 message와 같은 정보를 통해 data가 온전하게 전달되었는지 파악하기 수월하다.

• 정적 메서드 설계를 통해 원하는 응답 코드에 따라 CommonResopnseDto를 ResponseEntity로 감싸서 처리하도록 개발하며, Service 단에서 발생한 RuntimeException에 따른 response 처리 등을 개발해서 코드를 개선할 수 있다.