Skip to content

[Feat] Swagger 및 요청 로깅 개선#16

Merged
kallin1 merged 6 commits into
fix/17-jwt-auth-securityfrom
feat/#14-swagger-logging
Jul 13, 2026
Merged

[Feat] Swagger 및 요청 로깅 개선#16
kallin1 merged 6 commits into
fix/17-jwt-auth-securityfrom
feat/#14-swagger-logging

Conversation

@Hanharam

@Hanharam Hanharam commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

체크리스트

  • 병합 대상 브랜치가 올바른지 확인했습니다. (develop 또는 팀에서 합의한 개발 브랜치)
  • PR 제목을 컨벤션에 맞게 작성했습니다. 예: [Feat] 프롬프트 언락 기능 추가
  • 브랜치명을 컨벤션에 맞게 작성했습니다. 예: feat/#2-entity-config-setting
  • 관련 이슈를 연결했습니다.
  • 로컬에서 ./gradlew test 또는 ./gradlew build를 실행했습니다.
  • API 응답에 민감 정보, 토큰, 유료 프롬프트 원문이 노출되지 않는지 확인했습니다.

연관 이슈

작업 내용

  1. Swagger/OpenAPI 문서 설정을 추가했습니다.
  2. dev, prod 환경에서 Swagger 문서 경로를 Basic Auth로 보호하도록 설정했습니다.
  3. local profile 전용 Swagger 테스트 토큰 발급 API를 추가했습니다.
  4. Swagger UI에서 JWT 인증 테스트가 편하도록 authorization persist, try-it-out 설정을 추가했습니다.
  5. 보호 API에만 JWT security requirement가 표시되도록 OpenAPI customizer를 추가했습니다.
  6. Auth/User Controller의 Swagger 문서 애노테이션을 ControllerDocs 인터페이스로 분리했습니다.
  7. Swagger DTO 설명과 example을 보강했습니다.
  8. 요청 단위 MDC 로깅을 추가하고, 인증 사용자 컨텍스트(userId, memberId, userRole)를 포함하도록 보강했습니다.
  9. 주요 auth/user command 성공 이벤트와 refresh token family revoke 이벤트 로그를 추가했습니다.
  10. local profile용 application-local.yaml과 PostgreSQL datasource 설정을 추가했습니다.

변경 범위

  • auth
  • user
  • prompt
  • commerce
  • community
  • moderation
  • tracking
  • admin
  • common
  • global
  • 문서 / 설정 / 배포

리뷰 중점사항

  • 이 PR은 [Fix] JWT 인증 및 Refresh Token 보안 보강 #18 보안 보강 PR 위에 올라가는 stacked PR입니다. [Fix] JWT 인증 및 Refresh Token 보안 보강 #18 merge 후 이 PR을 확인해주세요.
  • Swagger 문서가 기본 비활성화 상태인지 확인해주세요.
  • dev, prod에서 Swagger 문서 접근 시 Basic Auth가 적용되는지 확인해주세요.
  • Swagger Basic Auth가 일반 API의 JWT 인증 정책에 영향을 주지 않는지 확인해주세요.
  • local 전용 /api/v1/auth/swagger-token이 local profile에서만 노출되는지 확인해주세요.
  • 요청 완료 로그 및 서비스 이벤트 로그에 raw password, token, Authorization header, full email이 남지 않는지 확인해주세요.
  • ControllerDocs 인터페이스 분리가 실제 컨트롤러 동작과 문서 시그니처를 어긋나게 만들지 않는지 확인해주세요.

테스트

  • ./gradlew test
  • ./gradlew build
  • 별도 확인:
    • 보안 PR 브랜치 위에 Swagger/로깅 커밋을 재구성한 뒤 전체 테스트 통과
    • Swagger 활성/비활성 조건 테스트
    • local/dev/prod 프로필별 Swagger 접근 제어 테스트
    • Swagger credential 누락 시 context startup 실패 테스트
    • 요청 MDC 생성 및 복원 테스트
    • unsafe request id/client IP sanitizing 테스트
    • 민감 정보가 완료 로그/MDC에 남지 않는지 테스트
    • OpenAPI JWT security requirement 적용 범위 테스트

스크린샷 / 응답 예시

  • 해당 없음

@Hanharam
Hanharam force-pushed the feat/#14-swagger-logging branch from 77fd7cf to f055782 Compare July 11, 2026 07:01
@Hanharam Hanharam changed the title [Feat] 스웨거 및 로깅 기능 추가 [Feat] Swagger 및 요청 로깅 개선 Jul 11, 2026
@Hanharam
Hanharam changed the base branch from develop to fix/17-jwt-auth-security July 11, 2026 07:03
@kallin1
kallin1 merged commit b6d9e18 into fix/17-jwt-auth-security Jul 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants