Backend , Frontend 공통 IDL 적용

간단 소개

프론트엔드와 백엔드의 협업 효율성을 높이기 위해 IDL을 도입하고 TypeScript 타입을 공유하여 얻은 효과와 구체적인 적용 방법을 설명한다.

AI Summary

IDL 도입 배경
- 프론트엔드와 백엔드가 각자 다른 타입을 사용하며 발생하는 중복 작업과 비효율성을 해결하기 위해 시작됨.
- 기존 방식의 문제점: 중복 타입 선언, 타입 파편화, 프론트엔드 선행 개발 시 API 변경에 따른 재설계 위험.
IDL 설계 및 적용
- IDL(Interface Description Language)을 통해 인터페이스를 명확하게 정의하고, 언어/플랫폼 중립성, 코드 재사용성, 개발 효율성을 확보.
- 강남언니 사례를 참고하여, 별도 프로젝트에서 TypeScript 타입 정의 파일을 생성하는 방식으로 결정.
- 프론트엔드가 타입을 먼저 작성하고, 백엔드가 PR 검토 후 사용하는 방식으로 협업 프로세스 구축.
IDL 운영 및 효과
- 모듈별 폴더 구조, HTTP API 인터페이스 작성 규칙, 상세 주석 작성 방법 등을 정의하여 일관성을 유지.
- 별도 저장소를 통해 관리하며, submodule 또는 private npm git packages 형태로 사용.
- 타입 통일, 이중 작업 감소, 인터페이스 히스토리 파악 용이, 클라이언트-서버 간 통신 규약 명시 등의 효과를 얻음.