프론트엔드
Backend , Frontend 공통 IDL 적용
두줄요약
백엔드와 프론트엔드의 API 타입을 공통 IDL로 통일한 도입 사례를 소개했습니다. 중복 작업을 줄이고 인터페이스 히스토리와 통신 규약을 함께 관리한 과정도 정리했습니다.
핵심 내용
- 백엔드와 프론트엔드가 같은 API를 각자 다른 타입으로 중복 정의하던 문제를 공통 IDL로 통일한 도입 사례
- 별도 레포지토리로 타입 전용 프로젝트를 두고, Frontend가 먼저 interface.ts와 models.ts를 작성한 뒤 Backend가 PR로 확인하며 사용하는 협업 방식
- 인터페이스 주석 컨벤션과 Base Type, 제네릭, 타입 별칭 규칙을 정해 API 히스토리와 통신 규약을 함께 관리
적용해볼 점
- 모듈 단위로 interface.ts와 models.ts를 분리해 타입 정의와 공통 모델을 관리하는 방식
- @before-ref, @authenticationPrincipal, @NOTE 같은 주석 규칙으로 이전 API 맥락과 인증 정보를 남기는 방식
- 서브모듈 또는 private npm git package로 공통 타입 저장소를 운영하는 방식
