Doc: swagger 어노테이션 추가

[Jjiggu]

작업 요약

Issue Link

문제점 및 어려움

해결 방안

Reference

Summary by CodeRabbit

• 문서화

  • 메뉴, 주점, 토큰 관련 API에 Swagger(OpenAPI) 문서화가 추가되어 API 사용 방법이 더 명확하게 안내됩니다.

• 스타일

  • 일부 컨트롤러에 로깅 기능이 추가되었습니다.

• 리팩터

  • 주점 목록 페이지네이션 조회 시 정렬 순서가 내림차순에서 오름차순으로 변경되었습니다.
  • Java 인터페이스 메서드의 불필요한 public 키워드가 제거되었습니다.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

OpenAPI(Swagger) 주석과 Lombok의 @Slf4j 로깅 어노테이션이 여러 컨트롤러에 추가되어 API 문서화 및 로깅 기능이 향상되었습니다. 또한, 주점(Store) 목록 조회 시 정렬 기준이 내림차순에서 오름차순으로 변경되었습니다. 일부 인터페이스 메서드의 불필요한 public 지정자가 제거되었습니다.

Changes

파일/경로 요약	변경 내용 요약
.../menu/controller/MenuController.java, .../store/controller/StoreController.java, .../token/controller/TokenController.java	OpenAPI(Swagger) 어노테이션(@Tag, @Operation, @ApiResponse) 및 Lombok @Slf4j 어노테이션 추가. API 문서화 및 로깅 기능 향상. 기존 로직 및 시그니처에는 영향 없음.
.../store/service/StoreService.java	인터페이스 메서드에서 불필요한 public 제거.
.../store/service/StoreServiceImpl.java, .../store/repository/StoreRepository.java	주점 목록 페이지네이션 조회 시 정렬 기준을 storeId 내림차순→오름차순으로 변경. @Override 어노테이션 추가.

Sequence Diagram(s)

sequenceDiagram
Controller ->> Service: getAllStoresByPage(Pageable)
Service ->> Repository: findAllByDeletedFalseOrderByStoreIdAsc(Pageable)
Repository -->> Service: Slice<Store>
Service -->> Controller: StoreReadResponse

Loading

Possibly related PRs

• [백엔드] store, menu 도메인 리팩토링 및 update, delete 추가 #5: MenuController에 OpenAPI 주석 및 로깅 추가와 관련된 변경으로, 동일 클래스에 대한 기능적/문서화적 변경이 함께 이루어진 PR입니다.

Suggested labels

enhancement

Suggested reviewers

• HyemIin

---

📜 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 e6f99a0 and abe54b6.

📒 Files selected for processing (6)

• application-user/src/main/java/com/nowait/applicationuser/menu/controller/MenuController.java (2 hunks)
• application-user/src/main/java/com/nowait/applicationuser/store/controller/StoreController.java (3 hunks)
• application-user/src/main/java/com/nowait/applicationuser/store/service/StoreService.java (1 hunks)
• application-user/src/main/java/com/nowait/applicationuser/store/service/StoreServiceImpl.java (1 hunks)
• application-user/src/main/java/com/nowait/applicationuser/token/controller/TokenController.java (2 hunks)
• domain-store/src/main/java/com/nowait/store/repository/StoreRepository.java (1 hunks)

✨ 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

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.