Skip to content

Comments

[chore(springBoot)] 스웨거 명세서 "성공 응답 예시 누락" 문제 해결 #80

Merged
vcz-Chan merged 2 commits intomainfrom
fix/swagger
Sep 28, 2025
Merged

[chore(springBoot)] 스웨거 명세서 "성공 응답 예시 누락" 문제 해결 #80
vcz-Chan merged 2 commits intomainfrom
fix/swagger

Conversation

@mdy3722
Copy link
Collaborator

@mdy3722 mdy3722 commented Sep 11, 2025

요약

  • 프론트와 원활한 통신, Gemini CLI의 효과적 활용을 위해 API 명세서 응답 예시는 필수입니다.
  • 기존 Spring Boot 백엔드 API 명세서에는 성공 응답에 대한 예시 구조가 명시되어 있지 않았습니다.
  • 이를 해결하여 스웨거 명세서에 성공에 대한 예시 응답 구조를 추가하였습니다.

관련 이슈

Changes

  • 응답 data를 반환하는 모든 컨트롤러에 대해 스웨거 명세서에 응답 data가 명시되도록 SuccessResponse<T>를 상속받는 구체적인 응답 DTO를 설계하였습니다.
  • void를 반환하여 응답 data가 비어있는 컨트롤러에 대해서는 적용하지 않았습니다.
  • 에러 메세지에 대한 명시 역시 적용하지 않았습니다. (필요시 적용하겠습니다.)

스크린샷 (예시)

스크린샷 2025-09-11 201157

@vcz-Chan vcz-Chan merged commit 0b4e20e into main Sep 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[♻️ Refactor] 현재 스웨거 명세서에 '응답 예시'가 보이지 않습니다.

2 participants