A.전화 개발자 협업의 기반 : 1,500 개의 API 명세와 SDK 통합 관리

이 게시물은 대용량 트래픽을 처리하는 에이닷 서비스의 API 명세와 SDK 관리 프로젝트 경험을 공유합니다.

주요 문제점

• 명세와 코드 불일치로 인한 협업 비효율
• 지루하고 반복적인 명세-코드 작업
• 버전 및 히스토리 관리 부재

해결책 및 구현

• OpenAPI Generator를 활용해 명세와 코드를 단일 소스로 통합
• Git을 통한 명세 파일 버전 및 히스토리 관리
• GitLab의 OpenAPI 렌더링과 Package Registry로 UI 제공 및 SDK 배포
• Gradle Plugin과 다양한 템플릿으로 언어별 빌드 및 배포 자동화

프로젝트 구조 및 워크플로우

• 단일 프로젝트에서 API 명세 작성, PR/MR 통한 협업
• CI를 통해 명세 병합, 코드 생성, 빌드, 패키지 배포
• 각 어플리케이션은 배포된 SDK 버전을 의존성으로 관리

결과 및 사용자 반응

• 지속적 사용과 커밋으로 활발한 개발 활동
• 일부 사용자들의 다양한 피드백과 기능 제한 인지