Backend , Frontend 공통 IDL 적용
백엔드
Backend , Frontend 공통 IDL 적용
두줄요약
Backend와 Frontend가 각각 관리하던 타입을 공통 IDL로 통일한 사례를 소개했습니다. 이를 통해 중복 작업을 줄이고 인터페이스 히스토리와 통신 규약을 함께 관리했습니다.
문제 상황
- Backend와 Frontend가 같은 API를 두고 서로 다른 타입을 따로 정의하는 중복 구조
- 타입 파편화와 설계 불일치로 인한 재작업, 로직 재설계, 컴포넌트 분리 부담
원인 분석
- 각자 필요한 타입을 개별 작성하면서 공통 규약 부재
- 프론트엔드 선행 작업 시 응답 타입 불일치로 개발 흐름이 깨질 가능성
해결 방법
- Backend와 Frontend가 함께 쓰는 공통 IDL 체계 도입
- 모듈별 interface.ts, models.ts 분리와 HTTP 메서드·경로 기반 인터페이스 정의
- 주석 메타데이터로 이전 API, 인증 방식, 기본값, 신규 타입 정보 관리
적용해볼 점
- 공통 타입 저장소를 별도 repository로 분리해 submodule 또는 private 패키지로 배포
- 인터페이스 히스토리와 서버-클라이언트 통신 규약을 한곳에서 관리