Skip to content

refactor: Swagger 스펙을 ControllerDocs 인터페이스로 분리 - #427

Merged
pooreumjung merged 7 commits into
developfrom
refactor/#426-extract-swagger-docs-interface
Jul 23, 2026
Merged

refactor: Swagger 스펙을 ControllerDocs 인터페이스로 분리#427
pooreumjung merged 7 commits into
developfrom
refactor/#426-extract-swagger-docs-interface

Conversation

@pooreumjung

@pooreumjung pooreumjung commented Jul 23, 2026

Copy link
Copy Markdown
Member

#️⃣ Issue Number

📝 요약(Summary)

  • auth, inquiry, menu(Meal/Menu), partnership, report, review(V1/V2), user 총 7개 도메인의 컨트롤러에서 @Operation/@ApiResponses/@Parameter(description=...) 등 Swagger 문서 애너테이션을 각 컨트롤러 전용 [ControllerName]Docs 인터페이스로 분리했습니다.
  • [ControllerName]Docs 인터페이스는 각 도메인의 presentation(또는 controller) 패키지 하위 docs 서브패키지에 위치합니다. (예: domain/review/presentation/docs/ReviewControllerV2Docs.java)
  • 컨트롤러는 해당 Docs 인터페이스를 implements하고 메서드에 @Override를 붙였습니다. @GetMapping 등 매핑 애너테이션과 @PathVariable/@RequestParam/@RequestBody 등 파라미터 바인딩 애너테이션은 기존과 동일하게 컨트롤러에 그대로 유지했습니다(문서화 관련 애너테이션만 이동).

💬 공유사항 to 리뷰어

  • ./gradlew compileJava는 정상 통과

✅ PR Checklist

PR이 다음 요구 사항을 충족하는지 확인하세요.

  • 커밋 메시지 컨벤션에 맞게 작성했습니다.
  • 변경 사항에 대한 테스트를 했습니다.(버그 수정/기능에 대한 테스트).

@pooreumjung pooreumjung added the refactoring 리팩토링 label Jul 23, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@pooreumjung pooreumjung self-assigned this Jul 23, 2026
@pooreumjung
pooreumjung merged commit 493e7c2 into develop Jul 23, 2026
1 check passed
@pooreumjung
pooreumjung deleted the refactor/#426-extract-swagger-docs-interface branch July 23, 2026 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactoring 리팩토링

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature: Swagger 스펙을 컨트롤러에서 분리하여 ControllerDocs 인터페이스로 이전

1 participant