[FIX] Swagger 원천 봉쇄

[PBEM22]

📌 관련 이슈

• close [FIX] 스웨거 막기 #193

✨ 변경 사항

📸 테스트 증명 (필수)

📚 리뷰어 참고 사항

✅ 체크리스트

• 브랜치 전략(git flow)을 따랐나요? (develop -> feat/...)
• 로컬에서 빌드 및 실행이 정상적으로 되나요?
• 불필요한 주석(TODO 등)이나 더미 코드는 제거했나요?
• 컨벤션(커밋 메시지, 코드 스타일)을 지켰나요?

Summary by CodeRabbit

릴리스 노트

• 새로운 기능

  • API 문서화 (Swagger UI) 추가 - 모든 엔드포인트를 웹 인터페이스에서 확인 가능
  • 주문 상태 관리 기능 개선

• 개선사항

  • 서버 헤더 포워딩 전략 추가로 인프라 안정성 강화
  • API 문서 자동 생성 및 표시 설정 최적화

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

개발 환경에서 주문 상태를 리셋할 수 있는 REST 엔드포인트가 추가되었습니다. 이를 위해 Order, Payment, Delivery 리포지토리에 삭제 메서드가 추가되었고, DevService에 상태 전이 로직이 구현되었으며, Swagger 설정이 활성화되었습니다.

Changes

Cohort / File(s)	변경 사항
리포지토리 삭제 메서드 추가 src/main/java/org/sopt/poti/domain/delivery/repository/DeliveryRepository.java, src/main/java/org/sopt/poti/domain/payment/repository/PaymentRepository.java	Order ID로 관련 Delivery/Payment 레코드를 삭제하는 Spring Data JPA 파생 쿼리 메서드 추가
주문 상태 업데이트 기능 src/main/java/org/sopt/poti/domain/order/entity/Order.java	updateStatus(OrderStatus status) 메서드 추가로 직접 상태 변경 가능
개발용 상태 리셋 엔드포인트 src/main/java/org/sopt/poti/global/dev/DevController.java	PATCH /dev/orders/{orderId}/status 엔드포인트 추가
상태 리셋 비즈니스 로직 src/main/java/org/sopt/poti/global/dev/DevService.java	resetOrderStatus() 메서드 추가: 목표 상태에 따라 Payment/Delivery 레코드 조건부 삭제
Swagger 및 서버 설정 src/main/resources/application.yml	API 문서 경로 설정 및 Swagger UI 커스터마이징 구성 추가

Sequence Diagram(s)

sequenceDiagram
    participant Client as 클라이언트
    participant Controller as DevController
    participant Service as DevService
    participant OrderRepo as OrderRepository
    participant PaymentRepo as PaymentRepository
    participant DeliveryRepo as DeliveryRepository
    participant DB as 데이터베이스

    Client->>Controller: PATCH /dev/orders/{orderId}/status?status=X
    Controller->>Service: resetOrderStatus(orderId, targetStatus)
    Service->>OrderRepo: findById(orderId)
    OrderRepo->>DB: SELECT Order
    DB-->>OrderRepo: Order
    OrderRepo-->>Service: Order
    
    alt targetStatus == WAIT_PAY
        Service->>PaymentRepo: deleteByOrder_Id(orderId)
        PaymentRepo->>DB: DELETE Payment
        Service->>DeliveryRepo: deleteByOrder_Id(orderId)
        DeliveryRepo->>DB: DELETE Delivery
    else targetStatus == WAIT_PAY_CHECK or PAID
        Service->>DeliveryRepo: deleteByOrder_Id(orderId)
        DeliveryRepo->>DB: DELETE Delivery
    end
    
    Service->>Service: order.updateStatus(targetStatus)
    Service->>DB: UPDATE Order status
    Service-->>Controller: void
    Controller-->>Client: 200 OK ApiResponse

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

여러 도메인에 걸쳐 변경이 있으며, 상태 전이 로직의 조건부 삭제 부분이 비즈니스 요구사항과 일치하는지 확인이 필요합니다.

Possibly related PRs

• [FEAT] 운송장 등록 API 구현 및 주문 조회 성능 최적화 #67: DeliveryRepository 쿼리 메서드 추가 및 배송 관련 주문 상태 워크플로우 구현으로 유사
• [FEAT] 구매자 입금자명, 입금시간 등록 API 구현 #52: Order와 PaymentRepository 도메인 클래스 수정으로 코드 레벨에서 연관성 있음

Suggested labels

🔥 P0, 🛒 Order

Suggested reviewers

• 88guri

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}