dramaling-app/docs/api/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文檔

1. 修改 swagger-ui.html 中的 OpenAPI JSON 規格
2. 測試文檔顯示是否正確
3. 確保所有API端點都有完整的文檔

建議改進

• 將內嵌的OpenAPI JSON分離為獨立的 openapi.yaml 文件
• 添加更多API模組的文檔
• 加入API使用範例和最佳實踐

---

建立日期: 2025-09-09
維護者: Drama Ling 開發團隊