63 lines
2.0 KiB
Markdown
63 lines
2.0 KiB
Markdown
# DramaLing API 文檔目錄
|
|
|
|
## 📚 當前有效文檔
|
|
|
|
### 🎯 主要開發文檔
|
|
- **[backend-development-plan.md](./backend-development-plan.md)** - 完整後端開發計劃
|
|
- 包含資料庫設計、API 規格、AI 整合、安全措施等
|
|
- 基於實際前端實作需求制定
|
|
- **這是後端開發的主要參考文檔**
|
|
|
|
- **[phase1-implementation-guide.md](./phase1-implementation-guide.md)** - Phase 1 實作指南
|
|
- 詳細的實作步驟和代碼範例
|
|
- 包含資料庫 Schema、API 實作、錯誤處理
|
|
- **立即可用的實作指南**
|
|
|
|
## 🗂️ 文檔使用指南
|
|
|
|
### 開始後端開發
|
|
1. 先閱讀 `backend-development-plan.md` 了解整體架構
|
|
2. 按照 `phase1-implementation-guide.md` 開始實作
|
|
3. 實作順序：資料庫 → 認證 → 詞卡 CRUD → AI 生成 → 錯誤處理
|
|
|
|
### 文檔狀態
|
|
- ✅ **最新** - 基於完整前端實作和需求規格書制定
|
|
- 🎯 **實用** - 包含可直接使用的代碼範例
|
|
- 🔄 **持續更新** - 隨開發進度更新
|
|
|
|
## 📦 已歸檔文檔
|
|
|
|
舊版文檔已移至 `archive/` 目錄：
|
|
- `archive/api-endpoints.md` - 舊版 API 端點文檔
|
|
- `archive/supabase-schema.md` - 舊版資料庫架構
|
|
- `archive/gemini-integration.md` - 舊版 AI 整合文檔
|
|
- `archive/api-specification.md` - 舊版 API 規格
|
|
- `archive/api-endpoints-detailed.md` - 舊版詳細端點文檔
|
|
|
|
這些文檔已被新版本取代，保留僅供參考。
|
|
|
|
## 🚀 快速開始
|
|
|
|
如果您準備開始後端開發：
|
|
|
|
1. **環境準備**
|
|
```bash
|
|
# 設定 Supabase 專案
|
|
# 取得 Gemini API Key
|
|
# 配置環境變數
|
|
```
|
|
|
|
2. **執行 Schema**
|
|
- 複製 `phase1-implementation-guide.md` 中的 SQL 到 Supabase
|
|
|
|
3. **實作 API**
|
|
- 按照指南逐步實作各個 API 端點
|
|
|
|
4. **測試**
|
|
- 使用已有的前端頁面測試 API 功能
|
|
|
|
## 📞 需要幫助？
|
|
|
|
- 查看具體實作問題：參考 `phase1-implementation-guide.md`
|
|
- 了解整體架構：參考 `backend-development-plan.md`
|
|
- 前端對應功能：查看 `/app` 目錄下的頁面實作 |