[feat] API & Swagger & Annotation

[millkk04]

📌 작업 개요

REST API 3개를 구현하고, Custom Validation 기능을 추가했습니다.

---

✅ 완료된 작업

1. 리뷰 추가 API 구현

• Endpoint: POST /api/reviews?memberId={memberId}
• 기능: 가게에 리뷰 작성
• Request Body: storeId, star (0.05.0), content (101000자)
• 구현 파일:
  • ReviewController, ReviewConverter
  • ReviewReqDTO, ReviewResDTO
  • ReviewErrorCode, ReviewException
  • ReviewCommandService, ReviewCommandServiceImpl
  • StoreRepository (신규 생성)

2. 미션 도전 API 구현

• Endpoint: POST /api/members/{memberId}/missions/{missionId}
• 기능: 회원이 특정 미션에 도전
• 주요 검증: 미션 마감일, 중복 도전, 가게/회원 존재 여부
• 구현 파일:
  • MissionController, MissionConverter
  • MissionReqDTO, MissionResDTO
  • MissionErrorCode, MissionException
  • MissionRepository, MemberMissionRepository (중복 체크 메서드 추가)
  • MissionCommandService, MissionCommandServiceImpl

3. 가게 추가 API 구현

• Endpoint: POST /api/stores
• 기능: 새로운 가게 등록
• Request Body: name, managerNumber, detailAddress, locationId
• 구현 파일:
  • StoreController, StoreConverter
  • StoreReqDTO, StoreResDTO
  • StoreErrorCode, StoreException
  • LocationRepository (신규 생성)
  • StoreCommandService, StoreCommandServiceImpl

4. 가게에 미션 추가 API 구현

• Endpoint: POST /api/stores/{storeId}/missions
• 기능: 특정 가게에 미션 생성
• Request Body: deadline, conditional, point
• 구현 파일:
  • MissionController (메서드 추가)
  • MissionConverter (변환 메서드 추가)
  • MissionReqDTO, MissionResDTO (DTO 추가)
  • MissionCommandService, MissionCommandServiceImpl (로직 추가)

5. Custom Validation 기능 구현

• @ExistFoods: 음식 카테고리 존재 여부 검증

  • FoodExistValidator 구현
  • FoodRepository.existsById() 활용

• @UniqueEmail: 이메일 중복 검증

  • UniqueEmailValidator 구현
  • MemberRepository.existsByEmail() 활용

• GlobalExceptionHandler 확장:

  • MethodArgumentNotValidException 처리 추가
  • Validation 실패 시 필드별 에러 메시지 반환

6. 회원가입 API 개선

• URL 변경: POST /api/members/register → POST /api/auth/register
• Validation 적용: @ExistFoods, @UniqueEmail, @Valid
• 에러 처리 개선:
  • "예기치 않은 서버 에러" → "이미 가입한 이메일입니다"
  • Validation 실패 시 구체적인 에러 메시지 반환

---

🗂️ 생성/수정된 주요 파일

신규 생성

• StoreRepository.java
• LocationRepository.java
• global/annotation/ExistFoods.java
• global/annotation/UniqueEmail.java
• global/validator/FoodExistValidator.java
• global/validator/UniqueEmailValidator.java

수정

• ReviewController, ReviewConverter, ReviewReqDTO, ReviewResDTO, ReviewErrorCode, ReviewException, ReviewCommandService, ReviewCommandServiceImpl
• MissionController, MissionConverter, MissionReqDTO, MissionResDTO, MissionErrorCode, MissionException, MissionCommandService, MissionCommandServiceImpl
• StoreController, StoreConverter, StoreReqDTO, StoreResDTO, StoreErrorCode, StoreException, StoreCommandService, StoreCommandServiceImpl
• MemberReqDTO (Validation 추가)
• MemberController (URL 변경)
• GlobalExceptionHandler (Validation 에러 처리 추가)

---

🎯 API 엔드포인트 목록

Method	Endpoint	기능
POST	/api/auth/register	회원가입
POST	/api/reviews	리뷰 작성
POST	/api/members/{memberId}/missions/{missionId}	미션 도전
POST	/api/stores	가게 추가
POST	/api/stores/{storeId}/missions	미션 추가

---

📝 기술 스택

• Spring Boot 3.5.7
• Java 21
• JPA / Hibernate
• MySQL
• Bean Validation
• QueryDSL
• Springdoc OpenAPI (Swagger)

---

🔍 주요 적용 기술

1. Validation

• @Valid, @NotNull, @NotBlank, @Size, @Min, @Max
• @Email, @Past, @Future, @DecimalMin, @DecimalMax
• Custom Validator: @ExistFoods, @UniqueEmail

2. 예외 처리

• Custom Exception: ReviewException, MissionException, StoreException
• ErrorCode Enum: ReviewErrorCode, MissionErrorCode, StoreErrorCode
• GlobalExceptionHandler로 일관된 에러 응답 형식

3. RESTful API 설계

• 리소스 계층 구조 명확화
• HTTP 메서드와 상태 코드 적절히 사용 (201 Created, 404 Not Found 등)
• PathVariable과 RequestBody 적절히 분리

4. 트랜잭션 관리

• @Transactional 적용
• 예외 발생 시 자동 롤백

---

🐛 해결한 이슈

1. 회원가입 시 email null 에러

• 원인: Member 엔티티의 email 필드가 nullable=false인데 요청에 email이 없음
• 해결: MemberReqDTO에 email 필드 추가, @Email 및 @UniqueEmail validation 적용

2. 음식 카테고리 존재하지 않음 에러

• 원인: DB에 food_category 데이터가 없음
• 해결: INSERT문 작성 및 data.sql에 추가

3. 이메일 중복 에러 메시지 지저분함

• 원인: DB constraint 위반 시 SQL 예외 메시지가 그대로 노출
• 해결: @UniqueEmail custom validator로 사전 검증

4. Validation 실패 시 에러 응답 형식 불일치

• 원인: MethodArgumentNotValidException 미처리
• 해결: GlobalExceptionHandler에 예외 처리 추가