- Reorganize project structure to unified apps/ directory - Move src/backend/ → apps/backend/ (complete .NET Core API) - Move src/mobile/ → apps/mobile/ (complete Flutter app) - Keep apps/web/ as Vue.js frontend - Remove duplicate src/ directory structure - Implement comprehensive SOP (Standard Operating Procedures) - Create sop/ unified management directory - Move CLAUDE.md → sop/docs/CLAUDE.md with updated guidelines - Move tools/, scripts/, archive/ → sop/ for centralized management - Establish three-tier task management architecture - Create unified task management system - Rename TASK_MANAGEMENT.md → TASKS.md for simplicity - Integrate 17 UI design tasks from ui-design-tasks.md - Update task priority classification (🔥緊急/⚠️重要/📝一般/💡想法) - Update ./dl script for new file paths - Archive obsolete systems and files - Archive old reports/ directory (replaced by sop/archive/) - Archive duplicate template files violating SOP principles - Clean up src/ directory documentation and configs 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| swagger-ui.html | ||
README.md
Drama Ling API 文檔
📖 概述
此目錄包含 Drama Ling API 的完整文檔和工具。
📁 文件說明
swagger-ui.html
- 用途: 互動式API文檔界面
- 使用方式: 在瀏覽器中直接開啟此文件
- 功能:
- 瀏覽所有API端點
- 測試API請求
- 查看請求/回應格式
🚀 使用方法
1. 本地查看API文檔
# 在瀏覽器中開啟
open docs/api/swagger-ui.html
2. 當前API覆蓋範圍
- ✅ 用戶認證模組: 註冊、登入、登出、第三方登入
- ✅ 健康檢查: 基本和詳細健康狀態
- 🔄 其他模組: 待補充 (詞彙學習、情境對話、遊戲化等)
📋 維護說明
更新API文檔
- 修改
swagger-ui.html中的 OpenAPI JSON 規格 - 測試文檔顯示是否正確
- 確保所有API端點都有完整的文檔
建議改進
- 將內嵌的OpenAPI JSON分離為獨立的
openapi.yaml文件 - 添加更多API模組的文檔
- 加入API使用範例和最佳實踐
建立日期: 2025-09-09
維護者: Drama Ling 開發團隊