Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 쿠폰 종류 조회 API 추가 #871

Merged
merged 3 commits into from
Feb 8, 2025

Conversation

Sangwook02
Copy link
Member

@Sangwook02 Sangwook02 commented Feb 8, 2025

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • 쿠폰 생성시 쿠폰 종류와 스터디 이름을 지정해야 합니다.
  • 각각의 조회 api가 필요한 상황인데, 후자는 /admin/studies로 대체 가능해서 쿠폰 종류 조회 api만 구현했습니다.

📝 참고사항

📚 기타

Summary by CodeRabbit

  • 새로운 기능
    • 쿠폰 관리 시스템에 쿠폰 타입 조회 기능이 추가되었습니다. 이를 통해 관리자는 등록된 다양한 쿠폰 유형 정보를 손쉽게 확인할 수 있게 되어, 쿠폰 운영 및 관리 효율성이 향상되었습니다.

@Sangwook02 Sangwook02 added the ✨ feature 새로운 기능 추가 및 수정 label Feb 8, 2025
@Sangwook02 Sangwook02 self-assigned this Feb 8, 2025
@Sangwook02 Sangwook02 requested a review from a team as a code owner February 8, 2025 07:41
Copy link

coderabbitai bot commented Feb 8, 2025

Walkthrough

이번 변경사항은 관리자가 쿠폰 타입 정보를 조회할 수 있도록 새로운 API 엔드포인트를 추가합니다. AdminCouponController에 GET /types 요청을 처리하는 getCouponTypes() 메서드가 추가되었으며, 이를 위해 CouponService에 getCouponTypes() 메서드와 CouponTypeResponse 레코드가 도입되어 쿠폰 타입 정보를 구성합니다.

Changes

파일 요약
src/main/java/.../coupon/api/AdminCouponController.java GET /types 엔드포인트를 위한 getCouponTypes() 메서드 및 관련 import 추가
src/main/java/.../coupon/application/CouponService.java CouponType 기반의 CouponTypeResponse 리스트를 반환하는 getCouponTypes() 메서드 추가
src/main/java/.../coupon/dto/response/CouponTypeResponse.java CouponTypeResponse 레코드와 from() 메서드 추가

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller as AdminCouponController
    participant Service as CouponService

    Client->>Controller: GET /types 요청
    Controller->>Service: getCouponTypes() 호출
    Service-->>Controller: CouponTypeResponse 리스트 반환
    Controller-->>Client: ResponseEntity<List<CouponTypeResponse>> 반환
Loading

Assessment against linked issues

Objective (관련 이슈) Addressed Explanation
쿠폰 타입 조회 API 추가 (#846)

Possibly related PRs

Suggested reviewers

  • kckc0608
  • uwoobeat

Poem

당근밭을 달리는 토끼처럼
새로운 코드 발자취 남기며
쿠폰의 비밀 문을 열었네
깔끔한 흐름 따라 달려가며
우리 모두 함께 웃는 날 되기를
귀여운 발자국, 축하의 춤을 춰요 🐇


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e2ffbb5 and 9b78017.

📒 Files selected for processing (1)
  • src/main/java/com/gdschongik/gdsc/domain/coupon/api/AdminCouponController.java (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/gdschongik/gdsc/domain/coupon/api/AdminCouponController.java

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Feb 8, 2025

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/main/java/com/gdschongik/gdsc/domain/coupon/application/CouponService.java (1)

151-153: 성능 최적화를 위한 캐싱 검토를 제안드립니다.

현재 구현은 깔끔하지만, CouponType이 enum이므로 값이 변경되지 않는 상수입니다. 따라서 결과를 캐싱하면 성능을 더욱 개선할 수 있습니다.

다음과 같이 캐싱을 적용해보세요:

+    private static final List<CouponTypeResponse> COUPON_TYPES = 
+            Arrays.stream(CouponType.values())
+                  .map(CouponTypeResponse::from)
+                  .toList();
+
     public List<CouponTypeResponse> getCouponTypes() {
-        return Arrays.stream(CouponType.values()).map(CouponTypeResponse::from).toList();
+        return COUPON_TYPES;
     }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 258fa76 and e2ffbb5.

📒 Files selected for processing (3)
  • src/main/java/com/gdschongik/gdsc/domain/coupon/api/AdminCouponController.java (2 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/coupon/application/CouponService.java (3 hunks)
  • src/main/java/com/gdschongik/gdsc/domain/coupon/dto/response/CouponTypeResponse.java (1 hunks)
🔇 Additional comments (2)
src/main/java/com/gdschongik/gdsc/domain/coupon/dto/response/CouponTypeResponse.java (1)

5-9: 구현이 깔끔하고 적절합니다!

Record를 사용하여 불변 데이터를 표현하고, 정적 팩토리 메서드를 통해 객체 생성을 캡슐화한 점이 좋습니다.

src/main/java/com/gdschongik/gdsc/domain/coupon/api/AdminCouponController.java (1)

48-53: API 구현이 일관성 있고 명확합니다!

기존 엔드포인트들과 동일한 패턴을 따르고 있으며, @operation 어노테이션을 통해 API 문서화가 잘 되어있습니다.

Copy link

github-actions bot commented Feb 8, 2025

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link
Member

@kckc0608 kckc0608 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@uwoobeat uwoobeat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Sangwook02 Sangwook02 merged commit 20691f7 into develop Feb 8, 2025
1 check passed
@Sangwook02 Sangwook02 deleted the feature/846-coupon-type-api branch February 8, 2025 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ feature 새로운 기능 추가 및 수정
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ 쿠폰 타입 조회 API 추가
3 participants