Skip to content

[REFACTOR/#504] 스웨거 에러 응답 명시 #504

Open

Description

@kimyw1018

1. 문제 상황 (As-Is)

  • 서버 측에서 ErrorCode를 구체적으로 분기하여 에러를 반환하고 있으나, Swagger(OpenAPI) 문서에 에러 응답 예시(Example)가 명시되어 있지 않음.
  • 프론트엔드에서 엔드포인트별로 어떤 에러 코드(상태 코드 및 비즈니스 에러 코드)가 발생할 수 있는지 사전에 확인하기 어려워 적절한 예외 처리 분기가 힘든 상황임.

2. 해결 방안 (To-Be)

  • 단일 소스인 ErrorCode 기반으로 엔드포인트별 발생 가능한 에러 목록을 Swagger 문서에 자동으로 생성하는 스키마 구조 구축
  • 작업 내용:
    1. SwaggerResponseDescription Enum에 엔드포인트별 예외 코드 Set 정의
    2. 커스텀 어노테이션 @CustomExceptionDescription 작성 및 Controller 메서드에 적용
    3. SwaggerConfig에 OperationCustomizer 빈 등록 및 addErrorResponseExamples 로직 구현
    4. 기존 Controller 핸들러 메서드 전체를 스캔하여 커스텀 어노테이션 적용 (전체 리팩터링)

🎯 TODO (작업 세부 내용)

  • SwaggerResponseDescription Enum 정의
  • @CustomExceptionDescription 어노테이션 구현 (@Retention(RetentionPolicy.RUNTIME))
  • SwaggerConfig 내 customExceptionOperationCustomizer() 빈 등록 및 예시 생성 로직 작성
  • 기존 Controller 전체 메서드에 @CustomExceptionDescription(...) 연결 및 매핑
  • Swagger UI에서 상태 코드별 Dropdown 예시 정상 노출 여부 검증

Activity

  1. self-assigned this
    on Oct 7, 2026
  2. changed the title [-][REFACTOR] 스웨거 에러 응답 명시[/-] [+][REFACTOR/#504] 스웨거 에러 응답 명시[/+] on Oct 7, 2026
  3. added a commit that references this issue on Oct 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions