feat(#4): 채팅 REST API 계약(Controller/DTO/Swagger/테스트) 추가#13
feat(#4): 채팅 REST API 계약(Controller/DTO/Swagger/테스트) 추가#13Yoonchulchung merged 9 commits intodevfrom
Conversation
Summary of ChangesHello @1000hyehyang, I'm Gemini Code Assist1! 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! 이 풀 리퀘스트는 채팅 기능의 REST API 계약을 확립하는 데 중점을 둡니다. 컨트롤러, 데이터 전송 객체(DTO), 스웨거 문서화를 Top-Down 방식으로 구성하여 API의 명확한 구조를 제공합니다. 또한, 테스트를 용이하게 하기 위해 샘플 응답을 생성하는 픽스처 팩토리를 포함하며, 커서 기반 페이지네이션을 위한 유틸리티와 관련 열거형을 정의하여 채팅 시스템의 기반을 마련합니다. Highlights
Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
이번 PR은 채팅 기능의 REST API 계약을 정의하고, 관련 DTO, 컨트롤러, Swagger 문서 및 테스트 코드를 추가하는 내용이네요. Top-Down 방식으로 구조를 잘 잡으셨고, 특히 FixtureFactory를 사용해 테스트 데이터를 분리한 점과 Swagger 인터페이스를 통해 API 명세를 관리하는 점이 인상적입니다. 전반적으로 깔끔하게 API 계약을 정의하셨습니다. 몇 가지 개선점을 제안드렸습니다. 보안 설정과 관련하여 테스트 목적으로 열어두신 API 엔드포인트는 실제 배포 전에 반드시 인증이 필요하도록 수정해야 합니다. 또한, 커서 파싱 로직에서 발생할 수 있는 예외에 대해 더 구체적인 오류 메시지를 제공하여 API 사용성을 높이는 방안을 제안드렸습니다. 코드 리뷰 참고하시어 더 완성도 높은 코드가 되길 바랍니다.
|
|
||
| private static final String[] PERMIT_ALL_URL_ARRAY = { | ||
| "/api/test", | ||
| "/api/chat/**", |
There was a problem hiding this comment.
PR 설명에 Swagger 테스트를 위해 채팅 API(/api/chat/**)를 모두 허용하도록 설정하셨다고 언급해주셨습니다.
개발 및 테스트 단계에서는 편리할 수 있지만, 인증 없이 채팅 관련 엔드포인트에 접근할 수 있게 되어 심각한 보안 위험을 초래할 수 있습니다. 예를 들어, 악의적인 사용자가 다른 사용자의 채팅방에 접근하거나 메시지를 보내는 등의 행위가 가능해질 수 있습니다.
실제 서비스에 배포되기 전에는 반드시 이 설정을 제거하고, @AuthenticationPrincipal을 사용하는 각 엔드포인트에 적절한 인증/인가 로직이 적용되도록 해야 합니다. 개발 환경에서만 이 설정을 적용하고 싶으시다면, Spring Profile을 사용하여 개발용 보안 설정을 분리하는 것을 고려해보시는 것이 좋습니다.
There was a problem hiding this comment.
로그인 인증 인가 pull 받으면 할거야
src/main/java/com/example/RealMatch/chat/presentation/conversion/MessageCursor.java
Outdated
Show resolved
Hide resolved
src/main/java/com/example/RealMatch/chat/presentation/conversion/RoomCursor.java
Outdated
Show resolved
Hide resolved
|
API 명세서부터 먼저 작성 부탁드립니다 |
넵!! |
2 participants
요약
채팅 REST API 계약을 확정하기 위해 Controller/DTO/Swagger/Test를 Top-Down 방식으로 구성했습니다.
샘플 응답은
ChatFixtureFactory로 분리했습니다.변경 사항
ChatController,ChatFixtureFactory)RoomCursor,MessageCursor)과 변환 컨버터 설정 추가테스트
ChatControllerTest작성 (MockMvc 기반 계약 테스트)참고