Skip to content

Chore: 스웨거 추가#19

Merged
stoneTiger0912 merged 3 commits intomainfrom
chore/add-swagger
Mar 2, 2026
Merged

Chore: 스웨거 추가#19
stoneTiger0912 merged 3 commits intomainfrom
chore/add-swagger

Conversation

@stoneTiger0912
Copy link
Member

@stoneTiger0912 stoneTiger0912 commented Mar 2, 2026

Summary by CodeRabbit

  • New Features

    • API 문서 및 대화형 UI 기능 추가
  • Chores

    • 구성 설정 최적화 및 상수 관리 개선
    • 종속성 및 내부 설정 구조 정리

@stoneTiger0912 stoneTiger0912 self-assigned this Mar 2, 2026
@stoneTiger0912 stoneTiger0912 merged commit e22ad09 into main Mar 2, 2026
1 check was pending
@stoneTiger0912 stoneTiger0912 deleted the chore/add-swagger branch March 2, 2026 08:25
@coderabbitai
Copy link

coderabbitai bot commented Mar 2, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c934dbb and 4c5f33f.

📒 Files selected for processing (7)
  • build.gradle
  • src/main/java/flipnote/group/global/config/AuditingConfig.java
  • src/main/java/flipnote/group/global/config/GrpcClientConfig.java
  • src/main/java/flipnote/group/global/config/QuerydslConfig.java
  • src/main/java/flipnote/group/global/config/SwaggerConfig.java
  • src/main/java/flipnote/group/global/constants/HttpConstants.java
  • src/main/resources/application.yml

둘러보기

프로젝트에 OpenAPI/Swagger 문서화 지원을 추가했습니다. springdoc-openapi 의존성을 추가하고, 세 개의 설정 클래스를 infrastructure.config에서 global.config 패키지로 이동했으며, SwaggerConfig와 HttpConstants 클래스를 신규 생성하고 application.yml에 Swagger UI 설정을 추가했습니다.

변경사항

코호트 / 파일 요약
패키지 이동
src/main/java/flipnote/group/global/config/AuditingConfig.java, src/main/java/flipnote/group/global/config/GrpcClientConfig.java, src/main/java/flipnote/group/global/config/QuerydslConfig.java
세 개의 설정 클래스를 infrastructure.config에서 global.config 패키지로 이동. 로직 변경 없음.
OpenAPI 설정
build.gradle, src/main/java/flipnote/group/global/config/SwaggerConfig.java, src/main/resources/application.yml
springdoc-openapi 의존성 추가 및 SwaggerConfig 클래스 신규 생성. OpenAPI 메타데이터 구성 및 프로덕션/로컬 서버 정의, USER_ID_HEADER 제거 커스터마이저 포함. Swagger UI 경로를 /groups/swagger-ui.html로 설정.
상수 정의
src/main/java/flipnote/group/global/constants/HttpConstants.java
HTTP 헤더 및 쿠키 관련 상수 4개를 정의하는 새로운 유틸리티 클래스 (USER_ID_HEADER, ACCESS_TOKEN_COOKIE, REFRESH_TOKEN_COOKIE, OAUTH_VERIFIER_COOKIE).

코드 리뷰 예상 난이도

🎯 2 (Simple) | ⏱️ ~10분

🐰 문서 달빛 아래, Swagger 춤을 춘다
API 명세서는 하늘 별처럼 반짝이고
설정들이 새로운 집으로 이주하는 동안
OpenAPI는 우리의 길을 밝혀주네
상수들이 정렬되고, 헤더들이 숨겨지고
모두가 한 곳으로 모여 조화로운 시스템을 이루도다! ✨

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/add-swagger

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant