Skip to content

[REFACTOR] 모든 API 경로를 /api/v1 아래로 통일 (GLB-298) - #208

Merged
giwoong01 merged 1 commit into
developfrom
refactor/api-v1-paths
Nov 17, 2026
Merged

giwoong01 merged 1 commit into
developfrom
refactor/api-v1-paths

Conversation

@giwoong01

@giwoong01 giwoong01 commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

#️⃣ 연관된 이슈

Jira GLB-298 (FE GLB-380)

📝 작업 내용

API 경로를 /api/v1 아래로 모았습니다. 백엔드에는 예전 경로를 남기지 않았고, FE가 개발 서버에서 맞춘 뒤 운영 릴리즈 때 같이 나갑니다.

예전 새 경로
POST /auth/token POST /api/v1/auth/token
POST /reissue POST /api/v1/auth/reissue
POST /logout POST /api/v1/auth/logout
DELETE /withdraw DELETE /api/v1/auth/withdraw
POST /auth/test-login (운영 테스트 로그인) POST /api/v1/auth/test-login
POST /dev/test-login (개발용) POST /api/v1/dev/test-login
GET /oauth2/authorization/kakao (카카오 로그인 시작) GET /api/v1/oauth2/authorization/kakao

그대로 둔 것

  • /login/oauth2/code/kakao: 카카오 개발자 콘솔에 등록된 콜백 주소
  • /actuator/health, Swagger(/swagger-ui, /v3/api-docs)
  • 나머지 API는 원래 /api/v1 아래에 있었습니다. GlobeController만 앞의 /가 빠진 api/v1/globes라 표기를 맞췄고, 동작은 같습니다.

함께 바꾼 것

  • 재발급 요청을 토큰 검사에서 빼 주는 경로(AuthorizationFilter)를 새 경로로 바꿨습니다.
  • 카카오 로그인 시작 경로(CustomOAuth2AuthorizationRequestResolver의 base URI)를 새 경로로 바꿨습니다. 인가 요청 Redis 저장소와 redirect_uri 허용 정책은 그대로 동작합니다.
  • Swagger 서버 주소에서 /api 접미사를 뺐습니다. 이제 경로가 /api/v1로 시작하므로 운영은 https://globber.world, 개발은 https://dev.globber.world, 로컬은 http://localhost:8080입니다.

설정 확인 결과 (변경 없음)

  • config/docker-compose-dev.yml과 설정 서브모듈의 app.oauth.redirect-domain(https://dev.globber.world/api 등)은 코드 어디에서도 읽지 않는 값이라 영향이 없습니다.
  • 카카오 redirect-uri는 콜백 경로이고 바뀌지 않았습니다.

프론트 할 일 (GLB-380)

  • API 기본 주소를 https://globber.world(개발은 https://dev.globber.world)로 바꾸고, 모든 호출을 /api/v1/...으로 합니다.
  • 로그인 시작 링크는 /api/v1/oauth2/authorization/kakao?redirect_uri=...입니다.
  • 인증 호출은 /api/v1/auth/token, /api/v1/auth/reissue, /api/v1/auth/logout, /api/v1/auth/withdraw입니다.
  • 개발 FE(Vercel) rewrites에 /api/v1/:path* → 개발 백엔드 /api/v1/:path*를 추가하고, /api/auth/token, /api/logout, /api/withdraw, /api/oauth2/* 같은 예전 규칙은 정리합니다.
  • 이 PR이 develop에 머지되면, FE가 맞추기 전까지 개발 서버에서 로그인·로그아웃·탈퇴·재발급이 실패합니다.

운영 반영 시 필요한 것 (릴리즈 때 진행)

  • 운영 Nginx가 앱 경로에서 /api를 떼지 않게 바꿔야 합니다. /api/v1/*을 그대로 넘기는 규칙은 이미 추가돼 있습니다.
  • 카카오 로그인 시작 경로 /api/v1/oauth2/authorization/*에도 지금 로그인 시작에 걸린 엄격한 요청 제한(초당 1회)을 옮겨야 합니다.
  • /api/actuator/health(배포 health 확인), /api/swagger-ui·/api/v3/api-docs·/v3/api-docs(Basic Auth), /login/oauth2/는 지금 규칙을 그대로 둡니다.
  • FE의 /api/v1 전환과 같은 날 내보내야 합니다.

🧪 테스트

  • ApiV1PathsTest (새로 추가, 수정 전 실패 확인)
    • 새 인증 경로들이 컨트롤러까지 도달하고, 예전 경로는 404 또는 405입니다.
    • 개발용 테스트 로그인은 새 경로에서 동작하고, 예전 경로는 없습니다.
    • GET /api/v1/oauth2/authorization/kakao는 카카오로 302 리다이렉트되고, 예전 경로는 404입니다.
    • API 문서의 모든 경로가 /api/v1/로 시작합니다.
  • 예전 경로를 쓰던 테스트(로그인 코드 교환, 로그아웃·탈퇴, 재발급, 운영 테스트 로그인, OAuth resolver, Swagger 서버 목록)를 새 경로로 바꿨습니다.
  • 전체 378개 통과

🤖 Generated with Claude Code

Summary by CodeRabbit

  • 변경 사항
    • 인증, OAuth 로그인, 토큰 교환·재발급, 로그아웃, 회원 탈퇴 및 테스트 로그인 경로가 /api/v1 경로로 통일되었습니다.
    • 글로브 조회 경로에 /api/v1 접두사가 적용되었습니다.
    • API 문서의 운영·개발 서버 주소에서 /api 경로가 제거되었습니다.
  • 테스트
    • 변경된 API 경로와 서버 주소를 기준으로 관련 테스트를 업데이트했습니다.

인증(/auth/token, /reissue, /logout, /withdraw), 테스트 로그인(/auth/test-login, /dev/test-login),
카카오 로그인 시작(/oauth2/authorization/*)을 /api/v1 아래로 옮긴다. 예전 경로는 남기지 않는다.
카카오 콜백(/login/oauth2/code/*), actuator, Swagger 경로는 그대로 둔다.
Swagger 서버 주소에서 /api 접미사를 뺀다.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@giwoong01 giwoong01 added the 🛠️ refactor 코드 구조 개선, 리팩토링 작업 label Nov 17, 2026
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

Note

.coderabbit.yml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

Parsing warnings: 1

Validation error: Unrecognized key: "common_ground_rules"
Configuration instructions

  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Walkthrough

인증, 테스트 로그인, 개발용 로그인, OAuth 시작 경로를 /api/v1 아래로 변경했습니다. 인증 필터와 관련 설명 주석, 테스트도 새 경로에 맞췄습니다. Swagger 운영·개발 서버 URL에서 /api를 제거했고, Globe 경로에 선행 /를 추가했습니다. 새 경로와 이전 경로의 응답, API 문서 경로를 검증하는 테스트를 추가하거나 갱신했습니다.

Estimated code review effort: 2 (Simple) | ~12 minutes

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

경로가 한 줄씩 새 주소를 찾아가고
OAuth도 새 표지판을 따라가네
테스트는 이전 길과 새 길을 확인하고
문서의 주소도 함께 정리되네
/api/v1 아래 발맞춘 경로들
작은 슬래시까지 제자리를 찾네

@github-actions

Copy link
Copy Markdown

Test Results

378 tests   378 ✅  21s ⏱️
 75 suites    0 💤
 75 files      0 ❌

Results for commit d86779e.

@github-actions

Copy link
Copy Markdown

🌻 테스트 커버리지 리포트

Overall Project 83.2% 🍏
File Coverage
SwaggerConfig.java 100% 🍏
MemberController.java 100% 🍏
SecurityConfig.java 100% 🍏
GlobeController.java 100% 🍏
TestAccountLoginController.java 92.48% 🍏
AuthorizationFilter.java 90.91% 🍏
LoginCodeStore.java 84.27% 🍏
OauthUtil.java 46.49% 🍏
TestLoginController.java 18.35% 🍏

@giwoong01
giwoong01 merged commit 6168d5d into develop Nov 17, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🛠️ refactor 코드 구조 개선, 리팩토링 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant