AI 요약관련 정보

• 일관되고 RESTful한 리소스 이름 지정: 리소스 이름은 항상 복수형 명사(예: /users)를 사용하고, 엔드포인트 경로에 동사를 포함하지 마세요. 🏷️
• 올바른 HTTP 상태 코드 반환: 리소스 생성 시 201 Created, 성공 시 200 OK 등 상황에 맞는 정확한 HTTP 상태 코드를 사용하고, ResponseEntity를 통해 응답을 완벽하게 제어하세요. 🚦
• DTO(Data Transfer Object) 사용: 데이터베이스 엔티티를 클라이언트에 직접 노출하지 말고, 요청 및 응답을 위한 별도의 DTO를 사용하여 데이터 노출을 제어하고 구조를 명확히 하세요. 📦
• 빈(Bean) 유효성 검사 활용: 수동적인 if 문 대신 @Valid, @NotBlank 등 Jakarta Validation 어노테이션을 사용하여 DTO의 유효성을 선언적으로 검증하세요. ✅
• 관심사 분리 (컨트롤러, 서비스, 리포지토리): 컨트롤러는 요청 처리, 서비스는 비즈니스 로직, 리포지토리는 데이터 접근을 담당하도록 역할을 명확히 분리하여 유지보수성과 테스트 용이성을 높이세요. 🏗️
• 페이지네이션 및 결과 제한 사용: 대량의 데이터를 반환할 때는 항상 페이지네이션(Pageable)을 적용하여 메모리 과부하를 방지하고 서버 안정성을 확보하세요. 📄
• 중앙 집중식 예외 처리: @ControllerAdvice와 @ExceptionHandler를 사용하여 모든 예외를 한 곳에서 처리하고, 클라이언트에게 일관된 오류 응답과 상태 코드를 제공하세요. 🚨
• API 보안 구현: 모든 API에 JWT, OAuth2, Basic Auth 등 적절한 보안 메커니즘을 적용하여 무단 접근을 방지하고 데이터 무결성을 보호하세요. 🔒
• API 버전 관리: /api/v1/users와 같이 API 버전을 명시하여 하위 호환성을 유지하고, 새로운 버전 개발 중에도 기존 클라이언트가 안정적으로 API를 사용할 수 있도록 하세요. 🔄
• API 문서화: Swagger 또는 OpenAPI와 같은 도구를 사용하여 API를 명확하게 문서화하여 API 소비자가 쉽게 사용 방법을 이해하고 통합할 수 있도록 지원하세요. 📚