URL 규칙과 요청/응답 형식을 명확히 정의하여 상세한 API 명세서를 작성했습니다. API 테스트 도구로 .http 파일을 기본적으로 사용하도록 정했고, 이를 레포지토리에 함께 커밋하여 팀원들이 동일한 환경에서 API를 테스트할 수 있도록 했습니다.
API 명세서
API 요청/응답 상세설명
.http 파일
서비스 간 통신 과정에서 혼동이 발생할 수 있는 부분을 사전에 파악하여, 전달 프로세스와 데이터 정의를 명확히 했습니다. 이를 문서화하여 혼란을 방지하고 팀 내 일관성을 유지했습니다.
팀 노션 내 페이지
템플릿 명세서 상세 페이지
Kafka 토픽 명세서
공통으로 사용하는 의존성과 라이브러리를 모노레포 구조의 공통 모듈로 코드를 관리하고, CI/CD 파이프라인을 통해 마이크로 서비스를 독립적으로 배포했습니다. 이를 통해 디펜던시의 모델과 버전 불일치로 인한 문제를 예방하고, 서비스 간 안정적인 연동을 보장했습니다.
프로젝트 계층
cd.yml
서비스 간 에러 처리를 위해 팀 내에서 표준화된 에러 코드와 처리 방식을 정의하고 적용했습니다.
공통 모듈 내 예외 패키지
에러코드