feat: springdoc-openapi로 Swagger API 문서 자동화 도입 - #231
Conversation
기존 REST 컨트롤러/DTO에 springdoc-openapi-ui를 붙여 /swagger-ui/index.html에서 전체 API 스펙(26개 엔드포인트)을 자동 생성한다. accessToken/refreshToken 커스텀 헤더 인증 방식에 맞춰 Swagger UI의 Authorize에서 두 헤더 값을 직접 입력해 테스트할 수 있도록 SecurityScheme을 구성했다.
|
Warning Review limit reached
Next review available in: 19 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
작업 배경
변경 사항
build.gradlespringdoc-openapi-ui:1.7.0의존성 추가 (Spring Boot 2.7.x / javax 네임스페이스와 호환되는 1.x 최종 버전)config/swagger/SwaggerConfig.java(신규)accessToken/refreshToken커스텀 헤더 인증을 위한 SecurityScheme 구성영향 범위
/swagger-ui/index.html에서 전체 API(10개 컨트롤러, 26개 엔드포인트) 확인 가능./v3/api-docs로 OpenAPI 3.0 JSON 스펙도 제공.Authorization: Bearer대신accessToken/refreshToken커스텀 헤더로 인증하므로, Swagger UI의 "Authorize"에서 두 헤더 값을 직접 입력해 바로 API를 테스트할 수 있도록 구성했다 (스크린샷 참고).Test Plan
./gradlew test전체 251/251 통과 (신규 의존성이 슬라이스 테스트 컨텍스트 로딩에 영향 없음 확인)/swagger-ui/index.html직접 확인 — 전체 엔드포인트 정상 렌더링, Authorize 모달에서 accessToken/refreshToken 헤더 입력 필드 확인🤖 Generated with Claude Code