Merge pull request 'docs(readme): 服務 URL 表格補上生產環境對應網址' (#54 ) from feat/swagger-coverage-gaps into master

Reviewed-on: #54
docs(readme): 服務 URL 表格補上生產環境對應網址
2026-06-23 08:05:36 +00:00 · 2026-06-23 16:03:11 +08:00 · 2026-06-23 07:27:32 +00:00 · 2026-06-23 15:23:18 +08:00
4 changed files with 24 additions and 12 deletions
@@ -78,3 +78,9 @@ VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
 VITE_REVERB_HOST="${REVERB_HOST}"
 VITE_REVERB_PORT="${REVERB_PORT}"
 VITE_REVERB_SCHEME="${REVERB_SCHEME}"
+
+# Swagger UI — API 伺服器 Base URL（結尾不加斜線）
+# 本地：http://localhost:8080/api
+# 生產：https://api.hank-space.com/api
+L5_SWAGGER_CONST_HOST=http://localhost:8080/api
+L5_SWAGGER_GENERATE_ALWAYS=false
@@ -33,6 +33,11 @@ jobs:
          docker compose exec -T app php artisan view:cache
          docker compose exec -T app php artisan event:cache

+      - name: Generate Swagger docs
+        run: |
+          cd /root/myproject/CFDivePlatform
+          docker compose exec -T app php artisan l5-swagger:generate
+
      - name: Restart queue worker
        run: |
          cd /root/myproject/CFDivePlatform
@@ -57,10 +57,10 @@ Swagger UI（由 l5-swagger 生成）涵蓋所有端點，包含：
 - 教練課程 / 時段 / 預約管理 / 資格驗證申請（證照送審）
 - 管理員後台

-| 環境 | Swagger UI URL |
-|------|----------------|
+| 環境 | Swagger UI |
+|------|-----------|
 | 本地 | http://localhost:8080/api/documentation |
-| JSON | http://localhost:8080/docs/api-docs.json |
+| 生產 | https://api.hank-space.com/api/documentation |

 ---

@@ -87,10 +87,11 @@ GET /health

 目前首頁尚未提供明顯導引到教練後台的入口。若要體驗教練功能，請直接開啟 `/coach/login`，使用上方教練試用帳號登入後會進入 `/coach/dashboard`。

-| 服務 | 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 |
+| 服務 | 本地 | 生產 |
+|------|------|------|
+| 前端 | http://localhost:8080 | https://app.hank-space.com |
+| API | http://localhost:8080/api | https://api.hank-space.com/api |
+| Swagger UI | http://localhost:8080/api/documentation | https://api.hank-space.com/api/documentation |
+| phpMyAdmin | http://localhost:8081 | http://\<vps-ip\>:8081 |
+| Mailpit | http://localhost:8025 | http://\<vps-ip\>:8025 |
+| Reverb WebSocket | ws://localhost:8085 | wss://ws.hank-space.com |
@@ -12,7 +12,7 @@ use OpenApi\Annotations as OA;
 * )
 * 
 * @OA\Server(
- *     url="/api",
+ *     url=L5_SWAGGER_CONST_HOST,
 *     description="API 伺服器"
 * )
 *
Author	SHA1	Message	Date
a620906209	d1fe3d4138	Merge pull request 'docs(readme): 服務 URL 表格補上生產環境對應網址' (#54 ) from feat/swagger-coverage-gaps into master Deploy Production / deploy (push) Successful in 13s Details Run Tests / test (push) Successful in 29s Details Reviewed-on: #54	2026-06-23 08:05:36 +00:00
a620906209	0bffa909e2	docs(readme): 服務 URL 表格補上生產環境對應網址 Run Tests / test (pull_request) Successful in 32s Details Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>	2026-06-23 16:03:11 +08:00
a620906209	9222bf17fc	Merge pull request 'fix(swagger): 修正 VPS 無法顯示 Swagger UI 的問題' (#53 ) from feat/swagger-coverage-gaps into master Deploy Production / deploy (push) Successful in 17s Details Run Tests / test (push) Successful in 33s Details Reviewed-on: #53	2026-06-23 07:27:32 +00:00
a620906209	b218fa0964	fix(swagger): 修正 VPS 無法顯示 Swagger UI 的問題 Run Tests / test (pull_request) Successful in 33s Details 問題根因： 1. deploy.yml 未執行 l5-swagger:generate，VPS 上不存在 api-docs.json 2. @OA\Server 使用相對路徑 "/api"，Swagger UI Try it out 無法正確打到 VPS API 修正： - @OA\Server 改用 L5_SWAGGER_CONST_HOST 常數，透過 .env 各環境設定 - deploy.yml 在 config:cache 後補上 l5-swagger:generate 步驟 - .env.example 補上 L5_SWAGGER_CONST_HOST 與 L5_SWAGGER_GENERATE_ALWAYS 說明 VPS .env 需手動加入： L5_SWAGGER_CONST_HOST=https://api.hank-space.com/api Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>	2026-06-23 15:23:18 +08:00