실무 가이드
연결 정보 관리
백엔드 서비스 연결 정보는 코드에 직접 넣지 않습니다.
Database=<설정 파일 또는 환경 변수>
StorageBasePath=<모듈 설정>
ExternalApiUrl=<환경별 설정>
ApiKey=<보안 저장소 또는 배포 자동화>
문서와 샘플에는 운영 계정, 운영 비밀값, 운영 주소를 넣지 않습니다.
서비스 추가 절차
새 백엔드 서비스를 붙일 때는 다음 순서로 진행합니다.
- 서비스 책임 모듈을 정합니다.
- 연결 설정의 위치를 정합니다.
- 개발용 더미 설정을 만듭니다.
- 실패 시 로그와 사용자 응답 기준을 정합니다.
- 계약 또는 API 경로를 문서화합니다.
- 검증 환경에서 운영과 같은 방식으로 연결을 확인합니다.
장애 대응 기준
백엔드 서비스 장애는 애플리케이션 오류와 분리해서 기록해야 합니다.
- 연결 실패
- 인증 실패
- 제한 시간 초과
- 응답 포맷 오류
- 외부 서비스의 비즈니스 오류
로그에는 요청 식별자, 거래 ID, 모듈 ID, 외부 서비스 이름, 실패 원인을 남깁니다. 단, 암호와 토큰은 남기지 않습니다.
체크리스트
- 서비스 주소와 인증 정보가 설정으로 분리되어 있는가?
- 로컬 개발 환경에서 대체 서비스나 더미 값을 사용할 수 있는가?
- 운영 장애 시 어떤 로그를 보면 되는지 명확한가?
- 화면 코드가 특정 DB나 외부 API에 직접 묶여 있지 않은가?
- 파일 저장소 경로와 보존 정책이 모듈 설정에 반영되어 있는가?