OpenAPI 스펙 기반 설계로 팀 인터페이스 합의 경험
팀 프로젝트에서 REST API를 처음 설계했을 때, 처음엔 URL 구조 없이 임의로 엔드포인트를 만들다가 팀원 간 혼선이 생겼습니다. 그 이후로 리소스 중심으로 URL을 설계하고 HTTP 메서드가 행위를 표현하게 맞추는 것과 응답 상태 코드를 의미에 맞게 구분하는 것을 원칙으로 정했습니다.
OpenAPI 스펙으로 먼저 API를 정의하고 팀원과 합의한 뒤 구현에 들어갔더니, 인터페이스 변경이 생겨도 스펙이 기준이 돼서 커뮤니케이션 비용이 줄었습니다. API 설계는 구현 편의보다 호출자 관점에서 명확성을 우선해야 한다는 걸 이 경험에서 배웠습니다. 지금도 API를 짜기 전에 호출 시나리오를 먼저 적어보는 습관을 유지하고 있습니다.