Skip to content

docs: Swagger 공통 에러 응답(ErrorResponse) 문서화 - #216

Merged
sjungwon03 merged 1 commit into
devfrom
docs/215-swagger-error-response
Jul 24, 2026
Merged

docs: Swagger 공통 에러 응답(ErrorResponse) 문서화#216
sjungwon03 merged 1 commit into
devfrom
docs/215-swagger-error-response

Conversation

@sjungwon03

Copy link
Copy Markdown
Member

변경 내용

  • OpenApiConfig에 공통 에러 응답(global.error.ErrorResponse) 스키마를 명시적으로 등록 (ErrorResponse/FieldErrorDetail)
    • 예외 핸들러(GlobalExceptionHandler)가 던지는 응답이라 컨트롤러 반환 타입만으로는 springdoc이 알 수 없어서 ModelConverters로 수동 등록
  • OperationCustomizer 빈을 추가해 전체 오퍼레이션에 4XX/5XX 공통 에러 응답을 전역으로 부여
    • 참고: 성공 응답 타입(ApiResponse<T> 제네릭)과 요청 DTO(Bean Validation 포함)는 docs: Swagger(OpenAPI) API 문서 도입 #213 에서 확인한 대로 springdoc이 컨트롤러 시그니처에서 이미 정확히 추론하고 있어 별도 작업이 필요 없었음

검증

  • ./gradlew spotlessApply./gradlew compileJava./gradlew test spotlessCheck 모두 통과
  • 로컬 인프라(docker compose MySQL/Redis/MinIO)로 앱을 직접 기동해 확인
    • /v3/api-docs: 전체 61개 오퍼레이션 모두에 200/4XX/5XX 응답 존재
    • ErrorResponse, FieldErrorDetail 스키마가 components.schemas에 정상 등록됨
    • 4XX/5XX 응답이 ErrorResponse 스키마를 올바르게 참조함

연결 이슈

Closes #215

성공 응답의 실제 타입(ApiResponse<T>)과 요청 DTO는 springdoc이 이미
정확히 추론하지만, 예외 핸들러가 던지는 ErrorResponse는 컨트롤러
시그니처에 드러나지 않아 문서에서 빠져 있었다. OpenApiConfig에서
ErrorResponse 스키마를 명시적으로 등록하고 OperationCustomizer로
모든 오퍼레이션에 4XX/5XX 공통 에러 응답을 전역으로 붙인다.

Closes #215
@sjungwon03 sjungwon03 added the docs 문서 작성 label Jul 24, 2026
@sjungwon03 sjungwon03 self-assigned this Jul 24, 2026
@kilo-code-bot

kilo-code-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 files)
  • src/main/java/com/bop/youthpick/global/config/OpenApiConfig.java

Reviewed by step-3.7-flash · Input: 49.7K · Output: 11.8K · Cached: 269.2K

@sjungwon03
sjungwon03 requested a review from myh7754 July 24, 2026 07:07
@sjungwon03
sjungwon03 merged commit 85837a6 into dev Jul 24, 2026
2 checks passed
@sjungwon03
sjungwon03 deleted the docs/215-swagger-error-response branch July 24, 2026 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서 작성

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Swagger 공통 에러 응답(ErrorResponse) 문서화

1 participant