[Docs] AI 에이전트 문서 보완

[KyeongJooni]

#️⃣ 연관된 이슈

• [Docs] #37 - AI 에이전트 문서 보완 #37

🚧 Work in Progress

• 작업 진행 중

📌 주요 변경사항

• 어드민 API 레퍼런스 문서(.claude/references/api/admin-*.md)에 하드코딩돼 있던 실제 백엔드 Swagger URL 제거
• URL은 로컬 전용 .env의 VITE_API_BASE_URL로 옮기고, 커밋되는 .env.example에는 빈 placeholder만 남김
• 이후 API 작업 시 AI 에이전트가 Swagger 출처를 문서에 직접 적지 않고 env 변수명만 참조하도록 정리

📝 작업 내용

• admin.md, admin-auth.md, admin-members.md, admin-projects.md, admin-reviews.md, admin-blog-reviews.md, admin-introductions.md의 "Swagger 출처" 줄을 실제 URL 대신 .env의 VITE_API_BASE_URL 참조로 교체
• endpoint 경로(/admin/members/pending 등)와 요청/응답 필드명은 그대로 유지 — 엔드포인트를 추측하지 않기 위한 계약 정보이고, 빌드된 프론트엔드 코드에도 어차피 노출되므로 문서에서 지워도 실질적 보안 효과가 없어 남김
• .env.example 추가로 VITE_API_BASE_URL 변수명을 팀에 공유하고, 실제 값은 이미 .gitignore로 제외된 로컬 .env에만 보관
• 검증: git status와 git check-ignore -v .env.example로 .env가 커밋 대상에서 제외되는지 확인. 문서/설정 변경만 있어 별도 빌드는 실행하지 않음

📸 스크린샷 (선택)

💬 리뷰 요구사항(선택)

• src/api가 아직 비어있어(.gitkeep만 존재) VITE_API_BASE_URL을 실제로 읽는 API client는 이번 PR에 포함되지 않았습니다 — 이후 client 구현 시 연결이 필요합니다.
• 각자 로컬 .env에 VITE_API_BASE_URL 값을 채워야 합니다(.env.example 복사).

Summary by CodeRabbit

• 문서
  • API 문서의 참조 주소가 고정된 서버 대신 설정된 API 서버 주소를 따르도록 변경했습니다.
  • 환경 설정 예시에 API 서버 주소 항목을 추가해, 프로젝트 환경에 맞는 주소를 지정할 수 있습니다.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: kusitms-com/makers-admin-fe/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Essentials

Run ID: a27c7efc-7338-4319-b951-e6be167a9147

📥 Commits

Reviewing files that changed from the base of the PR and between 2fd49bc and ab42807.

📒 Files selected for processing (8)

• .claude/references/api/admin-auth.md
• .claude/references/api/admin-blog-reviews.md
• .claude/references/api/admin-introductions.md
• .claude/references/api/admin-members.md
• .claude/references/api/admin-projects.md
• .claude/references/api/admin-reviews.md
• .claude/references/api/admin.md
• .env.example

Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

---

📝 Walkthrough

Walkthrough

관리자 API 참조 문서의 Swagger 주소를 고정 URL에서 VITE_API_BASE_URL 기반 주소로 변경했습니다. .env.example에 빈 값의 VITE_API_BASE_URL 항목을 추가했습니다.

Changes

Swagger 참조 URL

Layer / File(s)	Summary
Swagger URL 및 환경 변수 예시 변경 .env.example, .claude/references/api/admin*.md	.env.example에 빈 VITE_API_BASE_URL 항목을 추가했습니다. 관리자 API 참조 문서의 Swagger 주소를 해당 환경 변수 기반 주소로 변경했습니다. 대부분의 문서는 /api-docs/json을 사용하며, admin.md는 /swagger-ui/index.html#을 사용합니다.

Priority: ⬇️ Low

Change: Other

Merge Risk: ⚪ Minimal · up to ab428

These documentation and template changes show no established runtime or API-contract risk. Populate the local .env value when using the references; the PR is mergeable after normal checks.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	PR 제목은 관리자 API 문서의 Swagger URL 변경과 .env.example 추가라는 변경 범위를 문서 보완으로 정확하게 나타냅니다. 짧고 변경 내용과 관련되어 있습니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

---

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

CI 결과

항목	결과
TypeScript	🔴 실패
Prettier	⚪ 스킵
Generated	⚪ 스킵
ESLint	⚪ 스킵
Test	⚪ 스킵
Build	⚪ 스킵

[github-actions]

CI 결과

항목	결과
TypeScript	🟢 통과
Prettier	🟢 통과
Generated	🟢 통과
ESLint	🟢 통과
Test	🟢 통과
Build	🟢 통과