Doc: 어드민 영역 스웨거 문서 작업

[Jjiggu]

작업 요약

어드민 영역 스웨거 문서 작업

Issue Link

#29

문제점 및 어려움

해결 방안

Reference

Summary by CodeRabbit

• Documentation

  • 메뉴, 메뉴 이미지, 주점, 주점 이미지, 토큰 관련 API에 대한 Swagger(OpenAPI) 문서화가 추가되어 API 명세 확인이 용이해졌습니다.
  • 각 컨트롤러에 로그 기능이 추가되었습니다.

• Style

  • 메뉴, 메뉴 이미지, 주점, 주점 이미지 엔티티의 컬럼에 명시적인 JPA 제약 조건(Nullable 등)이 추가되어 데이터베이스 스키마가 명확해졌습니다.
  • 일부 엔티티 필드의 기본값 설정이 제거되고 명시적 제약 조건으로 대체되었습니다.

• Bug Fixes

  • 이미지 삭제 API의 응답 코드가 204에서 200으로 변경되어 성공 시 메시지 본문이 포함됩니다.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

이 변경사항은 여러 컨트롤러 클래스에 OpenAPI(Swagger) 어노테이션과 Lombok의 @Slf4j 로깅 어노테이션을 추가하여 API 문서화와 로깅 기능을 강화합니다. 또한 일부 엔티티 클래스에는 JPA 컬럼 제약 조건이 명시적으로 추가되고, 이미지 삭제 API의 HTTP 응답 코드가 204에서 200으로 변경되었습니다.

Changes

파일/경로 그룹	변경 요약
.../menu/controller/MenuController.java .../store/controller/StoreController.java .../token/controller/TokenController.java	컨트롤러 클래스에 OpenAPI(Swagger) 어노테이션(@Tag, @Operation, @ApiResponse)과 Lombok @Slf4j 추가. 기존 비즈니스 로직 변경 없음.
.../menu/controller/MenuImageController.java .../store/controller/StoreImageController.java	OpenAPI 어노테이션 및 @Slf4j 추가. 이미지 삭제 API의 응답 코드가 204에서 200으로 변경되고, 성공 메시지 본문 추가.
.../menu/entity/Menu.java	모든 필드에 JPA @Column 어노테이션으로 null 허용 여부 명시.
.../menu/entity/MenuImage.java .../store/entity/StoreImage.java	외래키 필드에 @Column(nullable = false) 추가로 not-null 제약 명시.
.../store/entity/Store.java	여러 필드에 JPA 컬럼 제약(nullable, length) 명시. isActive, deleted 필드의 기본값 및 @Builder.Default 제거.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller
    participant Service

    Client->>Controller: API 요청 (예: 메뉴 생성, 이미지 업로드 등)
    Controller->>Service: 비즈니스 로직 호출
    Service-->>Controller: 처리 결과 반환
    Controller-->>Client: 응답 (OpenAPI 명세, 변경된 HTTP 코드 포함)

Loading

Possibly related PRs

• [백엔드] store, menu 도메인 리팩토링 및 update, delete 추가 #5: MenuController에 대한 새로운 업데이트, 삭제, 토글 엔드포인트 및 서비스 메서드 추가. 본 PR과 동일한 컨트롤러를 대상으로 하지만, 기능 추가/수정이 아닌 문서화와 로깅 강화에 초점이 있음.

Suggested labels

enhancement

---

📜 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 13d735d and 61fce6b.

📒 Files selected for processing (9)

• application-admin/src/main/java/com/nowait/applicationadmin/menu/controller/MenuController.java (6 hunks)
• application-admin/src/main/java/com/nowait/applicationadmin/menu/controller/MenuImageController.java (2 hunks)
• application-admin/src/main/java/com/nowait/applicationadmin/store/controller/StoreController.java (5 hunks)
• application-admin/src/main/java/com/nowait/applicationadmin/store/controller/StoreImageController.java (3 hunks)
• application-admin/src/main/java/com/nowait/applicationadmin/token/controller/TokenController.java (2 hunks)
• domain-menu/src/main/java/com/nowait/menu/entity/Menu.java (2 hunks)
• domain-menu/src/main/java/com/nowait/menu/entity/MenuImage.java (1 hunks)
• domain-store/src/main/java/com/nowait/store/entity/Store.java (1 hunks)
• domain-store/src/main/java/com/nowait/store/entity/StoreImage.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.