ResponseEntity 사용에 대한 고민

1. 갑자기 고민

신규 서비스 프로젝트를 진행하면서 API의 Reponse Format을 어떻게 가져갈지에 대해 의문이 생겼다.
이전 회사에서는 별도의 Response VO를 만들어서 return 시켜줬는데, 이번에는 Spring web에서 제공해주는 ResponseEntity를 사용해보고자 생각이 들었다.
Spring 에서 API의 Response Format을 표준화 시키고자 만들어둔 클래스를 이용하는게 바람직하다고 생각되었고 다른 많은 회사에서도 ResponseEntity를 이용하고 있는 걸로 보인다.
토스나 네이버 OpenAPI를 봐도 이런 구조를 사용하는것 처럼 보인다.

2. 고민이후 정리된 내용

• HttpStatus 200번대 일 경우 body에 Data만 담아서 보냄
• HttpStatus 201번대의 경우 body는 null로, Client는 Status만 보고 해당 요청이 성공했는지를 판단하고 이후 로직 진행하도록
• HttpStatus 400번대의 경우 별도의 ResponseError VO를 body에 담아서 전달