🌿 중급 백엔드
API 응답 구조는 왜 일정해야 하나요?
쉽게 이해하기
편의점에서 음료수를 살 때 항상 같은 위치에 있으면 찾기 쉽죠. API 응답도 마찬가지예요. 데이터가 항상 같은 구조로 오면 프론트엔드에서 처리하기 훨씬 쉬워집니다.
핵심 정리
일관된 API 응답 구조는 프론트엔드 개발자가 예측 가능하게 데이터를 처리할 수 있게 해줍니다.
자세히 알아보기
API 응답 구조를 일정하게 유지하는 것은 백엔드와 프론트엔드 간의 약속과 같습니다. 예를 들어, 성공 응답은 항상 { success: true, data: {...} } 형식으로, 에러는 { success: false, error: {...} } 형식으로 보내기로 정하는 거죠.
이렇게 구조를 통일하면 프론트엔드 개발자는 매번 다른 형식을 확인할 필요 없이 일관된 방식으로 데이터를 처리할 수 있습니다. 또한 에러 처리 로직을 한 곳에서 관리할 수 있어 유지보수가 쉬워집니다.
실무에서는 보통 { status, message, data } 같은 기본 구조를 정해놓고, 모든 API 엔드포인트가 이 형식을 따르도록 합니다. 예를 들어 사용자 정보를 가져오는 API든, 상품 목록을 가져오는 API든 모두 같은 최상위 구조를 유지하는 거죠.
페이지네이션이 필요한 경우에도 { data: [...], pagination: { page, total, limit } } 처럼 일정한 패턴을 유지합니다. 이런 일관성은 팀 협업에서 특히 중요합니다.