fix: 광고 API 코드 스타일 프로젝트 컨벤션에 맞게 통일

[neibler]

🔍️ 작업 내용

• Closes #
  fix: 광고 API 코드 스타일 프로젝트 컨벤션에 맞게 통일

✨ 상세 설명

🛠️ 추후 리팩토링 및 고도화 계획

📸 스크린샷 (선택)

💬 리뷰 요구사항

Summary by CodeRabbit

릴리스 노트

• 새로운 기능

  • 홈 화면 광고 데이터를 조회하는 기능을 추가했습니다.

• 문서

  • API 문서의 광고 응답 정보에 대한 상세한 설명과 필드 정보를 추가했습니다.

[coderabbitai]

Walkthrough

광고 기능 API의 코드 정리 및 문서화 작업입니다. 임포트 재정렬, 메서드 시그니처 정리, Swagger 스키마 어노테이션 추가, 그리고 getHomeAdvertisements() 메서드 구현이 포함되었습니다. 기능적 동작은 변경되지 않았습니다.

Changes

Cohort / File(s)	Summary
컨트롤러 및 서비스 구현 src/main/java/com/ongil/backend/domain/advertisement/controller/AdvertisementController.java, src/main/java/com/ongil/backend/domain/advertisement/service/AdvertisementService.java	임포트 통합 및 정렬 정리. AdvertisementService에 getHomeAdvertisements() 메서드 구현 추가. AdvertisementController의 메서드 시그니처 정리(빈 매개변수 라인 제거).
DTO 및 변환기 문서화 src/main/java/com/ongil/backend/domain/advertisement/dto/AdvertisementResponse.java, src/main/java/com/ongil/backend/domain/advertisement/converter/AdvertisementConverter.java	AdvertisementResponse 레코드에 Swagger @Schema 어노테이션 추가(클래스 및 4개 필드에 한국어 설명). 변환기의 임포트 위치 및 인덴테이션 정정.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

• [fix] 광고 API 코드 스타일 프로젝트 컨벤션에 맞게 통일 #124: 광고 API 코드 스타일 및 규약 통일 목표와 일치하며, 컨트롤러·서비스·DTO·변환기의 일관된 개선을 다룹니다.

Possibly related PRs

• feat: 홈 화면 광고 조회 API 구현 (Mock Data) #51: 동일한 광고 기능의 컨트롤러·서비스·변환기·DTO를 수정하며, 특히 getHomeAdvertisements API 관련 작업(기존 PR은 엔드포인트 및 서비스 추가, 현재 PR은 시그니처 및 어노테이션 조정)이 연계됩니다.
• refactor: 홈 화면 통합 API 더미 데이터를 실제 서비스 호출로 변경 #99: 현재 PR이 AdvertisementService#getHomeAdvertisements와 AdvertisementResponse 어노테이션을 추가하며, 이는 기존 PR의 HomeService/HomeConverter에서 광고를 조회하고 포함하는 데 직접 활용됩니다.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	PR 제목은 '광고 API 코드 스타일 프로젝트 컨벤션에 맞게 통일'로, 실제 변경사항과 부분적으로만 일치합니다. 코드 포맷팅 및 임포트 정리가 주요 변경이지만, 동시에 새로운 메서드 구현(AdvertisementService#getHomeAdvertisements 추가)과 Swagger 스키마 주석 추가 등 스타일 통일을 넘어선 기능적 변경도 포함되어 있습니다.	제목이 모든 변경을 포괄하지 못합니다. 주요 변경사항(메서드 구현, Swagger 주석 추가)을 포함하거나, 스타일 통일에만 해당하는 변경으로 PR 범위를 명확히 하세요.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/124

---

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments

src/main/java/com/ongil/backend/domain/advertisement/service/AdvertisementService.java (1)

20-30: Mock 데이터 구현은 깔끔하나, 향후 DB 전환 시 고려사항이 있습니다.

현재 Mock 데이터로 동작하는 점은 이해하지만, 두 가지 참고 사항을 남깁니다:

1. @Transactional(readOnly = true)가 클래스 레벨에 선언되어 있어, DB 조회가 없는 현재 상태에서는 불필요한 트랜잭션 컨텍스트가 생성됩니다. 실제 DB 연동 시점까지는 메서드 레벨로 제한하거나, DB 전환 시 자연스럽게 활용될 것이므로 그대로 두어도 무방합니다.
2. 광고 개수 5가 @Operation 설명과 서비스 코드에 하드코딩되어 있습니다. 추후 상수나 설정값으로 추출하면 유지보수성이 향상됩니다.

---

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.}