Home

척척학사 Backend Wiki

척척학사 백엔드는 수원대학교 포털의 학사 데이터를 비동기로 가져오고, 학생별 이수 현황과 졸업 요건을 계산하는 Spring Boot 서비스입니다.

이 Wiki는 로컬 실행, 서비스 구조, 개발 규칙, 릴리즈와 장애 대응을 설명합니다. 최신 API 계약은 실행 중인 Swagger에서 확인합니다.

목적별 문서 안내

목적	문서	확인할 내용
처음 실행하기	Getting Started	필수 도구, .env, 로컬 실행, 첫 검증
서비스 이해하기	Project Architecture, Core Domain Flows	Lambda 런타임, 패키지 책임, 포털 연동과 졸업 진단
설계 이유 확인하기	Architecture Decision Records	주요 기술 결정의 맥락, 대안, 결과, 재검토 조건
API 사용하기	API and Authentication	API 영역, JWT, OIDC, 내부 콜백 인증
개발하기	Development Guide	이슈, 브랜치, 테스트, API 문서, Flyway 변경 절차
릴리즈하기	Release Management, Deployment and Operations	버전과 브랜치 정책, dev·prod 배포, 롤백
문제 해결하기	Troubleshooting, Troubleshooting Case Studies	증상별 Runbook과 과거 장애·성능 개선 사례

주요 링크

• Backend 저장소
• GitHub Actions
• Issue
• 운영 Swagger
• 개발 Swagger

갱신 기준

• 코드와 동작이 다르면 dev 브랜치의 코드와 테스트를 우선합니다.
• API 요청·응답은 컨트롤러의 docs 인터페이스와 /v3/api-docs를 확인합니다.
• dev·prod 스키마 변경은 src/main/resources/db/migration의 Flyway SQL만 사용합니다.
• 환경 변수의 값, 토큰, 포털 계정, DB 접속 정보는 Wiki와 Issue에 기록하지 않습니다.
• 주요 아키텍처 결정이 바뀌면 기존 ADR을 덮어쓰지 않고 대체 ADR을 추가합니다.
• 동작이나 Workflow가 바뀐 PR은 관련 Wiki 페이지도 함께 갱신합니다.
• 아직 main에 반영되지 않은 정책은 전환 안내를 표시하고 현재 동작과 구분합니다.