88 lines
1.9 KiB
Markdown
88 lines
1.9 KiB
Markdown
# O2Sound Backend API Documentation
|
|
|
|
O2Sound 백엔드 API 서버의 기술 문서입니다.
|
|
|
|
## 📚 문서 목록
|
|
|
|
### 1. [API Documentation](./API_Documentation.md)
|
|
전체 API 엔드포인트에 대한 상세한 설명과 사용법을 포함합니다.
|
|
- 인증 API
|
|
- 사용자 관리 API
|
|
- 영상 제작 API
|
|
- 소셜 로그인 API
|
|
- 에러 처리 가이드
|
|
|
|
### 2. [API Quick Reference](./API_Quick_Reference.md)
|
|
빠른 참조를 위한 API 호출 예제 모음입니다.
|
|
- cURL 명령어 예제
|
|
- Python 클라이언트 예제
|
|
- JavaScript/TypeScript 클라이언트 예제
|
|
- 환경 변수 설정
|
|
|
|
### 3. [Developer Guide](./Developer_Guide.md)
|
|
개발자를 위한 상세한 가이드입니다.
|
|
- 프로젝트 구조
|
|
- 개발 환경 설정
|
|
- 새 기능 추가 방법
|
|
- 테스트 및 배포
|
|
- 문제 해결
|
|
|
|
## 🚀 빠른 시작
|
|
|
|
### 요구사항
|
|
- Python 3.9+
|
|
- PostgreSQL 14+
|
|
- Redis 6+
|
|
- Poetry
|
|
|
|
### 설치 및 실행
|
|
```bash
|
|
# 1. 의존성 설치
|
|
poetry install
|
|
|
|
# 2. 환경 변수 설정
|
|
cp .env.local .env
|
|
|
|
# 3. 데이터베이스 마이그레이션
|
|
poetry run alembic upgrade head
|
|
|
|
# 4. 개발 서버 실행
|
|
poetry run uvicorn main:app --reload
|
|
```
|
|
|
|
### API 문서 확인
|
|
- Swagger UI: http://localhost:8000/docs
|
|
- ReDoc: http://localhost:8000/redoc
|
|
|
|
## 📋 주요 기능
|
|
|
|
1. **사용자 인증 및 관리**
|
|
- 회원가입/로그인
|
|
- Google OAuth 2.0
|
|
- 프로필 관리
|
|
|
|
2. **영상 제작 자동화**
|
|
- URL 기반 크롤링
|
|
- AI 가사 생성
|
|
- 음악 생성
|
|
- 비디오 제작
|
|
- 최종 병합
|
|
|
|
3. **비즈니스 관리**
|
|
- 업체 정보 CRUD
|
|
- 생성된 비디오 관리
|
|
- 비디오 스트리밍
|
|
|
|
## 🛠 기술 스택
|
|
|
|
- **웹 프레임워크**: FastAPI
|
|
- **비동기 작업**: Celery
|
|
- **메시지 브로커**: Redis
|
|
- **데이터베이스**: PostgreSQL
|
|
- **ORM**: SQLAlchemy
|
|
- **인증**: Session + OAuth 2.0
|
|
|
|
## 📞 문의
|
|
|
|
문제가 있거나 질문이 있으시면 이슈를 생성해주세요.
|