Skip to content

♻️ refactor: API Response, Request DTO 구현, ApiProperty 추가 #451

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

Merged
merged 20 commits into from
Aug 22, 2025

Conversation

Jo-Minseok
Copy link
Member

@Jo-Minseok Jo-Minseok commented Aug 11, 2025

🔨 테스크

Issue

Response DTO에 ApiProperty의 필요성

  • 현재 Swagger를 이용한 API 명세서는 별도의 파일에서 example, schema를 구현하도록 했으나, Response DTO가 변경되면 Swagger도 함께 바꿔야하는 문제 발생
  • Swagger에서 Response type을 Response DTO로 설정하여 DTO에서 응답 값들을 제어하도록 변경

Request DTO의 필요성

  • 간단한 Parameter일지라도, Request DTO를 사용한 이유는 '값 검증'을 하는 단계를 오로지 Request DTO에서만 수행하도록 하기 위해 Parameter가 1개인 곳도 DTO를 사용하도록 했다.

📋 작업 내용

  • Response DTO 구현
  • Request DTO 구현
  • 파일 추가 삭제 API DTO 적용
  • Response DTO ApiProperty 추가
  • 필요없는 코드 정리
  • Controller 응답 코드 추가

다음 작업

  1. Swagger 리팩토링
  2. 각종 명칭(파일, 함수, 변수, 클래스명) 일관화
  3. Test 코드 리팩토링

@Jo-Minseok Jo-Minseok added the 🔨 Refactor 리팩토링 (구조 변경) label Aug 11, 2025
@Jo-Minseok Jo-Minseok requested a review from asn6878 August 11, 2025 15:10
@Jo-Minseok Jo-Minseok self-assigned this Aug 11, 2025
@Jo-Minseok Jo-Minseok requested a review from CodeVac513 August 11, 2025 15:10
@Jo-Minseok Jo-Minseok changed the title ♻️ refactor: API Response DTO 전부 추가, ApiProperty 추가 ♻️ refactor: API Response, Request DTO 구현, ApiProperty 추가 Aug 11, 2025
Copy link
Member

@asn6878 asn6878 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
Collaborator

@CodeVac513 CodeVac513 left a comment

Choose a reason for hiding this comment

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

정말 수고 많으셨습니다!
전반적으로 깔끔하게 작업해주셔서 좋습니다.

궁금한 점 하나 남겨두었습니다. :)

@Jo-Minseok Jo-Minseok merged commit c342f8e into main Aug 22, 2025
2 checks passed
@Jo-Minseok Jo-Minseok deleted the refactor/api branch August 22, 2025 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 Refactor 리팩토링 (구조 변경)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants