介面文件
Swagger API 文件
本項目採用 Swagger實現 RESTful API 的互動式介面文件,開發者可通過文件直觀查看、測試各 API 介面的具體定義與使用方式。
文件訪問方式
每個服務啟動時均會自動啟用 Swagger 文件服務。
若後端服務運行於 埠號 3022(可依實際配置調整),請透過以下網址訪問對應的介面文件:
http://localhost:3022/api-docs
TIP
請根據實際項目配置的伺服器埠號(如 3000、3022 或其他自訂埠)替換上述網址中的
3022
開發環境下通常預設啟用 Swagger,生產環境是否開放需視具體部署設定而定
文件界面支持介面參數測試、響應範例查看等互動功能,便於前端與後端協作開發