백엔드-프론트엔드 협업에서 API 스펙 불일치가 생긴 원인과 해결 과정을 서술
팀 프로젝트에서 백엔드를 맡았는데, 프론트엔드 팀원과 API 명세를 구두로만 맞추다가 문제가 발생했습니다. 제가 반환하는 JSON 필드명이 userId였는데, 프론트엔드에서 user_id로 파싱하고 있었습니다. 데이터가 제대로 들어오지 않는 것을 마감 이틀 전에야 발견했습니다.
원인은 명세를 문서로 공유하지 않은 것이었습니다. 서로 머릿속에서 다르게 이해하고 있었는데 확인할 공동 기준이 없었던 것입니다. 그 이후로 스프레드시트에 API 엔드포인트, 요청/응답 형식, 필드명을 정리하여 공유했습니다. 변경이 생기면 먼저 문서를 업데이트하고 알리는 방식도 정했습니다.
이후 프로젝트에서는 API 개발 시작 전에 명세 문서부터 먼저 작성했습니다. 프론트엔드 팀원이 '이렇게 하니까 기다리는 시간이 줄었다'고 말했습니다. 협업에서 가장 중요한 것은 서로의 전제를 맞추는 것이며, 그 전제를 글로 남겨두는 것이 나중에 생기는 혼선을 막는 가장 빠른 방법이라는 것을 배웠습니다.