[CHORE] REST Docs 기반 OpenAPI 생성 환경 구축

[GiJungPark]

Related Issue

• chore/[CHORE] REST Docs 기반 OpenAPI 생성 환경 구축 #584 -> dev
• Closes [CHORE] REST Docs 기반 OpenAPI 생성 환경 구축 #584

Key Changes

• REST Docs 문서 테스트를 OpenAPI 3 명세로 변환하고 Swagger UI WebJar가 해당 명세만 제공하도록 구성했습니다. 문서 산출물은 build/ 아래에서 재생성하며, 로그아웃의 성공·오류 응답과 Deprecated 개발용 로그인 API를 실제 Controller 요청으로 문서화합니다. (7965951e)
• Authorization 헤더가 없거나 Bearer 형식이 아닌 보호 API 요청도 빈 401 대신 공통 AUTH-001 ErrorResult JSON을 반환하도록 인증 실패 응답을 통일했습니다. 실제 Security filter chain을 사용하는 Controller 테스트로 누락·비-Bearer·변조·토큰 유형 오류를 검증합니다. (9deaa1b4)
• 개발 CD가 일반 테스트는 제외하면서 별도 문서 테스트와 OpenAPI 생성을 실행하도록 빌드 명령을 clean apiDocs build -x test로 변경했습니다. 생성 명세가 포함된 bootJar가 Docker 이미지에 들어갑니다. (c7ede183)
• AuthController 문서 테스트를 auth/controller/auth 패키지 아래 API별 PostAuthLogoutDocsTest, PostUserIdLoginDocsTest 클래스로 분리했습니다. 클래스명은 HTTP Method와 API 의미가 드러나도록 구성했습니다. (85fa49d0)

To Reviewers

• Swagger UI는 현재 origin을 사용하는 servers.url: /와 ./openapi3.json을 사용하므로 Blue-Green의 8080/8081 포트나 localhost를 하드코딩하지 않습니다. 기존 설정대로 dev에서는 활성화되고 prod에서는 비활성화됩니다.
• src/test/resources/swagger-ui/openapi3.json은 생성 산출물이 아니라 Swagger 리소스 핸들러 테스트가 독립 실행될 때 사용하는 최소 fixture입니다. 실제 생성 명세는 build/api-docs-resources/swagger-ui/openapi3.json이며 Git으로 추적하지 않습니다.
• 스웨거 경로는 /swagger-ui/index.html# 입니다.
• DB, Nginx, 서버 deploy.sh, 프로필별 yml은 변경하지 않았습니다.

References

• [REFACTOR] 로그인 및 토큰 인증 구조 개선 #554
• [TEST] 인증 Controller 테스트에 Access Token 적용 기반 마련 #574
• [TEST] API 문서 테스트 공통 기반 구축 #585

[ljy1348]

좋아요