a620906209
05ef8b9316
- 修正 AuthApiDoc.php 路徑錯位（/register/member → /member/register 等） 及 change-password 方法（Post→Put）；補上 POST /logout、GET /user - 新增 AuthSupplementDoc.php（Google OAuth 2 端點） - 新增 PublicApiDoc.php（共用 Schema + 公開課程 4 端點） - 新增 MemberApiDoc.php（預約、評價、通知共 13 端點） - 新增 ProviderApiDoc.php（課程、圖片、時段、預約管理共 18 端點） - 新增 AdminApiDoc.php（統計、會員/教練/課程管理共 16 端點） - 更新 README.md - 歸檔 swagger-api-docs-completion change，同步主規格 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
## ADDED Requirements
|
||
|
||
### Requirement: Member 端點 Swagger 文件
|
||
|
||
`app/Docs/MemberApiDoc.php` SHALL 文件化所有需要 Member Bearer token 的端點（bookings、reviews、helpful 投票、notifications）。
|
||
|
||
#### Scenario: Member bookings 端點文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 以下端點均有文件，並標示 `security: bearerAuth`：
|
||
- `POST /member/bookings`（request: schedule_id；response 201: Booking）
|
||
- `GET /member/bookings`（response: Booking 陣列 + 分頁 meta）
|
||
- `GET /member/bookings/{id}`（response: Booking 詳情）
|
||
- `DELETE /member/bookings/{id}`（response 200: message）
|
||
|
||
#### Scenario: Member reviews 端點文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 以下端點均有文件：
|
||
- `POST /member/reviews`（request: diving_offer_id、rating、comment；403 資格驗證失敗；422 重複評價）
|
||
- `PUT /member/reviews/{id}`（request: rating?、comment?；403 非本人）
|
||
- `DELETE /member/reviews/{id}`（403 非本人）
|
||
- `POST /reviews/{id}/helpful`（toggle，response: helpful_count、has_voted）
|
||
|
||
#### Scenario: Member notifications 端點文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 以下端點均有文件：
|
||
- `GET /notifications`（response: 通知陣列 + 分頁 meta）
|
||
- `GET /notifications/unread-count`（response: count）
|
||
- `PATCH /notifications/{id}/read`
|
||
- `PATCH /notifications/read-all`
|
||
- `DELETE /notifications/{id}`
|