배송/화물현황과 리스크/알림(api 활용, 공공데이터 복구시 대체될 가능성 있음)
This commit is contained in:
87
backend-node/README_API_SETUP.md
Normal file
87
backend-node/README_API_SETUP.md
Normal file
@@ -0,0 +1,87 @@
|
||||
# 🔑 API 키 설정 가이드
|
||||
|
||||
## 빠른 시작 (신규 팀원용)
|
||||
|
||||
### 1. API 키 파일 복사
|
||||
```bash
|
||||
cd backend-node
|
||||
cp .env.shared .env
|
||||
```
|
||||
|
||||
### 2. 끝!
|
||||
- `.env.shared` 파일에 **팀 공유 API 키**가 이미 들어있습니다
|
||||
- 그대로 복사해서 사용하면 됩니다
|
||||
- 추가 발급 필요 없음!
|
||||
|
||||
---
|
||||
|
||||
## 📋 포함된 API 키
|
||||
|
||||
### ✅ 한국은행 환율 API
|
||||
- 용도: 환율 정보 조회
|
||||
- 키: `OXIGPQXH68NUKVKL5KT9`
|
||||
|
||||
### ✅ 기상청 API Hub
|
||||
- 용도: 날씨특보, 기상정보
|
||||
- 키: `ogdXr2e9T4iHV69nvV-IwA`
|
||||
|
||||
### ✅ ITS 국가교통정보센터
|
||||
- 용도: 교통사고, 도로공사 정보
|
||||
- 키: `d6b9befec3114d648284674b8fddcc32`
|
||||
|
||||
### ✅ 한국도로공사 OpenOASIS
|
||||
- 용도: 고속도로 교통정보
|
||||
- 키: `7820214492`
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ 주의사항
|
||||
|
||||
### Git 관리
|
||||
```bash
|
||||
✅ .env.shared → Git에 커밋됨 (팀 공유용)
|
||||
❌ .env → Git에 커밋 안 됨 (개인 설정)
|
||||
```
|
||||
|
||||
### 보안
|
||||
- **팀 내부 프로젝트**이므로 키 공유가 안전합니다
|
||||
- 외부 공개 프로젝트라면 각자 발급받아야 합니다
|
||||
|
||||
---
|
||||
|
||||
## 🚀 서버 시작
|
||||
|
||||
```bash
|
||||
# 1. API 키 설정 (최초 1회만)
|
||||
cp .env.shared .env
|
||||
|
||||
# 2. 서버 시작
|
||||
npm run dev
|
||||
|
||||
# 또는 Docker
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 트러블슈팅
|
||||
|
||||
### `.env` 파일이 없다는 오류
|
||||
```bash
|
||||
# 해결: .env.shared를 복사
|
||||
cp .env.shared .env
|
||||
```
|
||||
|
||||
### API 호출이 실패함
|
||||
```bash
|
||||
# 1. .env 파일 확인
|
||||
cat .env
|
||||
|
||||
# 2. API 키가 제대로 복사되었는지 확인
|
||||
# 3. 서버 재시작
|
||||
npm run dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**팀원 여러분, `.env.shared`를 복사해서 사용하세요!** 👍
|
||||
Reference in New Issue
Block a user