이번주에는 API를 설계하기 위한 기본적인 설정을 해주도록 하겠습니다.
여기까지 오느라 다들 고생 많으셨고… 조금만 더 힘내보아요 ~ 👊🏻
실습을 진행하기 전 새로운 Issue를 파기 → branch 생성 → Local에서 새로운 브랜치로 checkout 하고 시작해 주세요 !! 이제는 기본적으로 새로운 코드를 작성하기에 앞서서 해주시면 됩니다 !!
<aside> 💡
예전에 여러분들께 API가 정보를 뽑아주는 자판기와 같다고 말씀 드렸습니다.
결국은 프론트엔드 팀원들을 위해서 서버에서 정보를 뽑아올 수 있는 API를 만드는 것이고.. 프론트엔드 팀원들이 유용하게 사용할 수 있도록 응답 형태를 만들어줄 필요가 있습니다.
⚠️ 생각해 봅시다,
API 명세서도 같은 형태로 모든 API에 대한 정보를 작성해서 표로 만들어 놓았는데..? 개인 메모처럼 API 명세서를 만든다면 나 말고 남들은 알아보기 쉽지 않겠죠?
같은 맥락으로 API 응답 통일이 필요합니다.
</aside>
🤨 그래서 어떤 것을
Controller에서 API를 호출을 하면 HTTP 응답 메시지가 돌아오게 됩니다.
다른 부분들은 Custom화 하지 않습니다.
위의 사진에서 파란색 부분 즉, message body에 실습에서 만든 API의 응답을 JSON 형태로 넣어줄겁니다.
나중에 Swagger를 통해서 API를 테스트 해줄때 위와같이 Response Body에 저희가 만든 API 응답이 JSON 형태로 들어가 있는 것을 확인할 수 있어요!
⭐ API 응답 통일이란 모든 API에서 저렇게 응답 형태를 통일해서 반환한다는 뜻입니다.
👀 그렇다면 사람들은 보통 어떤 형태로 API 응답을 통일할까요??
Example 1.