비브로스 기술 블로그 · 2024. 03. 26.
Backend , Frontend 공통 IDL 적용
AI 엔지니어링 브리핑
똑닥은 백엔드와 프론트엔드가 서로 다른 타입을 따로 관리하며 생기던 중복 작업과 불일치를 줄이기 위해 공통 IDL을 도입했습니다.
문제 & 배경
- 문제 & 배경: 같은 API를 사용하면서도 백엔드와 프론트엔드가 각자 타입을 작성해 타입이 파편화되고, 실제 응답이 예상과 다르면 프론트엔드 설계와 컴포넌트를 다시 만들어야 했습니다.
기술 & 해결책
- 기술 & 해결책: 별도 프로젝트에서 프론트엔드가 API의 요청·응답 타입과 설명을 먼저 정의한 TypeScript 파일을 만들고, 백엔드가 이를 검토한 뒤 함께 사용하도록 모듈별 인터페이스와 모델을 관리했습니다.
교훈 & 주의점
- 교훈 & 주의점: 공통 타입을 한곳에서 관리하면 이중 작업을 줄이고 통신 규약과 변경 이력을 쉽게 확인할 수 있으며, 도입 전에는 팀 간 협의와 저장소·패키지 운영 방식을 정해야 합니다.
함께 읽을 글
내용이 비슷해요내용이 비슷한 글을 먼저 보여드려요. 같은 문제나 해결책을 다룬다는 뜻은 아니에요.