[FEATURE #25]: swagger ui 적용

[khyun9807]

📌 개요

작업 목적을 간단히 설명해주세요.

🔧 작업 내용

• 작업한 기능 / 수정한 버그 목록

✅ 체크리스트

테스트 완료(Postman, Swagger)

📝 기타 참고 사항

• 주의할 점, 추후 리팩토링 필요성 등

📎 관련 이슈

Close #25

[gemini-code-assist]

Summary of Changes

Hello @khyun9807, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

이 PR은 주로 Swagger UI를 통합하여 API 문서화 및 개발자 경험을 향상시키는 데 중점을 둡니다. 다양한 엔드포인트와 데이터 전송 객체에 포괄적인 OpenAPI 어노테이션을 도입하여 API 사양을 쉽게 접근하고 이해할 수 있도록 했습니다. 또한, 프로젝트의 아키텍처, 컨벤션 및 주요 기능에 대한 중요한 정보를 제공하는 상세한 프로젝트 개요 문서(CLAUDE.md)가 추가되었습니다. 사용되지 않는 JoinRequest DTO 파일이 제거되는 사소한 변경도 포함되었습니다.

Highlights

• Swagger UI 통합: API 문서화를 위해 Swagger UI를 통합했습니다. springdoc-openapi-starter-webmvc-ui 의존성을 추가하고 Swagger 설정을 구성했습니다.
• API 문서화 어노테이션 추가: 컨트롤러 및 DTO 전반에 걸쳐 @Tag, @Operation, @Parameter, @Schema, @SecurityRequirement 등 OpenAPI 어노테이션을 광범위하게 적용하여 상세한 API 문서를 제공합니다.
• JoinRequest.java 파일 제거: auth 패키지 내 JoinRequest DTO 파일이 제거되었습니다. 이는 사용자 등록 흐름의 간소화 또는 리팩토링을 의미할 수 있습니다.
• 새로운 CLAUDE.md 파일 추가: 프로젝트 정책, 기술 스택, 빌드/실행 방법, 프로젝트 구조, 패키지 컨벤션, 주요 패턴(API 응답, 엔티티, 소프트 삭제, 페이지네이션, 인증 흐름, 보안, 유효성 검사, 트랜잭션), 주요 엔티티 및 프로필을 상세히 설명하는 CLAUDE.md 문서가 추가되었습니다.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• CLAUDE.md
  • 새로운 프로젝트 문서 파일이 추가되었습니다.
• build.gradle
  • Swagger를 위한 springdoc-openapi-starter-webmvc-ui 의존성이 추가되었습니다.
• src/main/java/com/payper/server/auth/AuthController.java
  • API 그룹화를 위한 @Tag 어노테이션이 추가되었습니다.
  • 로그인, 토큰 재발급, 로그아웃 엔드포인트에 상세 문서화를 위한 @Operation 및 @Parameter 어노테이션이 추가되었습니다.
  • 토큰 재발급 및 로그아웃에 @SecurityRequirement가 추가되었습니다.
• src/main/java/com/payper/server/auth/dto/request/JoinRequest.java
  • 파일이 제거되었습니다.
• src/main/java/com/payper/server/auth/dto/request/LoginRequest.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/auth/dto/response/LoginSuccessResponse.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/auth/dto/response/ReissueSuccessResponse.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/comment/controller/CommentController.java
  • API 그룹화를 위한 @Tag 어노테이션이 추가되었습니다.
  • 댓글 수정, 삭제, 내 댓글 조회, 대댓글 조회 엔드포인트에 @Operation, @Parameter, @SecurityRequirement 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/comment/dto/CommentRequest.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/comment/dto/CommentResponse.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/global/config/SwaggerConfig.java
  • 보안 스키마 정의를 포함한 Swagger OpenAPI 설정을 위한 새로운 구성 파일이 추가되었습니다.
• src/main/java/com/payper/server/global/response/ApiResponse.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/global/response/ExceptionDto.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/global/response/FieldErrorDto.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/merchant/controller/MerchantController.java
  • API 그룹화를 위한 @Tag 어노테이션이 추가되었습니다.
  • 게시글 작성 엔드포인트에 @Operation, @Parameter, @SecurityRequirement 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/post/controller/PostController.java
  • API 그룹화를 위한 @Tag 어노테이션이 추가되었습니다.
  • 게시글 수정, 삭제, 상세 조회, 목록 조회, 댓글 작성, 게시글 댓글 조회 엔드포인트에 @Operation, @Parameter, @SecurityRequirement 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/post/dto/PostRequest.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.
• src/main/java/com/payper/server/post/dto/PostResponse.java
  • DTO 및 필드에 @Schema 어노테이션이 추가되었습니다.

Activity

• khyun9807님이 이 PR을 생성했습니다.
• 새로운 CLAUDE.md 파일이 추가되었으며, 이는 프로젝트 개요 문서로 보입니다.
• build.gradle 파일이 Swagger UI 의존성을 포함하도록 수정되었습니다.
• 수많은 컨트롤러 및 DTO 파일이 API 문서화를 위한 Swagger 어노테이션을 추가하기 위해 수정되었습니다.
• JoinRequest.java 파일이 제거되었습니다.
• Swagger 구성을 위한 새로운 SwaggerConfig.java 파일이 추가되었습니다.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

Swagger UI 적용을 위한 PR이네요. 전반적으로 API 명세가 잘 추가되었고, DTO와 컨트롤러에 상세한 설명과 예시가 포함되어 API를 이해하기 쉬워졌습니다. 몇 가지 수정이 필요한 부분을 발견하여 리뷰에 남겼습니다. 특히 build.gradle 파일의 의존성 버전 오류는 빌드 실패를 유발할 수 있으니 꼭 확인해주세요.

[seoyeon2001]

controller에 swagger까지 붙이니까 좀 복잡해서
swagger는 따로 인터페이스 문서로 빼고 구현하는 걸로 하는 건 어떨까요?

[seoyeon2001]

고생하셨습니다.