From b218fa09649f38404ed146066b3c512845adae05 Mon Sep 17 00:00:00 2001 From: Hank Date: Tue, 23 Jun 2026 15:23:18 +0800 Subject: [PATCH] =?UTF-8?q?fix(swagger):=20=E4=BF=AE=E6=AD=A3=20VPS=20?= =?UTF-8?q?=E7=84=A1=E6=B3=95=E9=A1=AF=E7=A4=BA=20Swagger=20UI=20=E7=9A=84?= =?UTF-8?q?=E5=95=8F=E9=A1=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 問題根因: 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 --- .env.example | 8 +++++++- .gitea/workflows/deploy.yml | 5 +++++ app/Docs/AuthApiDoc.php | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.env.example b/.env.example index c84015f..88cb57f 100644 --- a/.env.example +++ b/.env.example @@ -77,4 +77,10 @@ REVERB_SCHEME=http VITE_REVERB_APP_KEY="${REVERB_APP_KEY}" VITE_REVERB_HOST="${REVERB_HOST}" VITE_REVERB_PORT="${REVERB_PORT}" -VITE_REVERB_SCHEME="${REVERB_SCHEME}" \ No newline at end of file +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 \ No newline at end of file diff --git a/.gitea/workflows/deploy.yml b/.gitea/workflows/deploy.yml index 230a113..8aaed47 100644 --- a/.gitea/workflows/deploy.yml +++ b/.gitea/workflows/deploy.yml @@ -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 diff --git a/app/Docs/AuthApiDoc.php b/app/Docs/AuthApiDoc.php index 7679349..48a4df0 100644 --- a/app/Docs/AuthApiDoc.php +++ b/app/Docs/AuthApiDoc.php @@ -12,7 +12,7 @@ use OpenApi\Annotations as OA; * ) * * @OA\Server( - * url="/api", + * url=L5_SWAGGER_CONST_HOST, * description="API 伺服器" * ) *