파트너플랫폼 스쿼드 코드 컨벤션 소개 🌼

올리브영 파트너플랫폼 스쿼드는 서비스 개선 과정에서 도출된 의견을 바탕으로 코드의 가독성, 유지보수성, 팀 협업 강화를 위한 코드 컨벤션을 수립했다.

주요 컨벤션 내용은 다음과 같다.

• 편집 설정: .editorconfig를 활용해 IDE(IntelliJ IDEA 등)의 들여쓰기, 인코딩 등을 일관되게 관리한다.
• 패키지 구조: 의존성과 도메인/비즈니스 로직의 분리를 핵심으로 하여 확장 가능한 구조를 설계한다.
• 명명 규칙: 축약어 사용을 지양하고, Layer별(Controller, Service, Repository)로 메서드 명칭을 다르게 정의하여 역할(비즈니스 로직 vs 데이터 접근)을 명확히 구분한다.
• API 설계: URI는 단수 명사를 사용하며, 대량 처리가 필요한 경우 bulk를 명시한다. 또한 HTTP Method를 적극 활용하여 리소스를 관리한다.
• 응답 규격: 일관된 Response 응답 코드와 메시지 규칙을 적용한다. 목록 데이터는 Generic 타입을 사용하여 응답 형태를 통일하고, 단일 리소스 응답 시에는 식별자(Identifier)를 포함해 클라이언트의 후처리를 돕는다.