docs(swagger): 補全缺漏端點標註 + 更新 README 文件 URL
Run Tests / test (pull_request) Successful in 32s

新增 11 個先前缺漏的 @OA 標註:
- Token Refresh(Member / Provider / Admin)
- Provider 資格驗證申請(show / upload / delete cert / submit)
- 即時訊息聊天室(unread-counts / list / send / mark-read)

其他:
- l5-swagger.php 標題改為 CFDive Platform API
- README 補充 Swagger UI URL 與 JSON 端點位置

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-06-23 15:08:15 +08:00
parent 4afe7b5fd5
commit 60ff56a571
5 changed files with 401 additions and 8 deletions
+10 -4
View File
@@ -50,13 +50,18 @@
## API 文件
Swagger 文件涵蓋公開、會員、教練、管理員與認證端點,包含:
- 認證(Email + Google OAuth
Swagger UI(由 l5-swagger 生成)涵蓋所有端點,包含:
- 認證(Email + Google OAuth、Token 刷新
- 公開課程查詢
- 會員預約 / 訊息 / 評價 / 通知
- 教練課程 / 時段 / 預約管理
- 會員預約 / 即時訊息 / 評價 / 通知
- 教練課程 / 時段 / 預約管理 / 資格驗證申請(證照送審)
- 管理員後台
| 環境 | Swagger UI URL |
|------|----------------|
| 本地 | http://localhost:8080/api/documentation |
| JSON | http://localhost:8080/docs/api-docs.json |
---
## 健康檢查
@@ -85,6 +90,7 @@ GET /health
| 服務 | URL |
|------|-----|
| API / 前端 | http://localhost:8080 |
| Swagger UI | http://localhost:8080/api/documentation |
| phpMyAdmin | http://localhost:8081 |
| Mailpit | http://localhost:8025 |
| Reverb WebSocket | ws://localhost:8085 |