本文介紹在Linux系統下調試Swagger的步驟。
一、安裝Swagger ui和Swagger Editor
首先，需要安裝Swagger UI和Swagger Editor。推薦使用docker安裝Swagger UI，方便快捷。
-
安裝Swagger UI (Docker): 執行以下命令拉取并運行Swagger UI鏡像：
docker pull swaggerapi/swagger-ui:v4.15.5 docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
這將啟動一個Swagger UI容器，并將其8080端口映射到主機的38081端口。
-
安裝Swagger Editor (手動): Swagger Editor需要手動下載靜態文件，并配置Web服務器。 使用以下命令下載：
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.js wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.css
將下載的文件放置到Web服務器的目錄下（例如/var/www/html），并配置服務器（apache或nginx）使其可訪問。
二、Swagger配置
接下來，需要配置Swagger UI指向你的API文檔。
-
配置Swagger UI: 修改Swagger UI的配置文件（通常是index.html），將url參數指向你的API文檔的URL。例如：
script src="swagger-editor.js" type="text/javascript">script> window.onload = function() { const editor = Swaggereditor({ url: "http://your-api-docs-url" // 替換為你的API文檔URL }); };
三、訪問和調試
-
訪問Swagger UI: 在瀏覽器中訪問http://localhost:38081/swagger-ui.html (或你配置的URL)。 你將看到Swagger UI界面，列出可用的API接口。
四、調試注意事項
- 檢查容器狀態: 使用docker ps命令檢查Swagger UI容器是否運行。
- 端口映射: 確保端口映射正確。
- 安全配置: 根據需要配置Swagger UI的安全設置（例如密碼保護）。
五、使用ide調試 (可選)
高級調試可以使用IDE（如IntelliJ idea或VS Code）進行遠程調試。 需要在IDE中配置遠程調試，連接到Swagger UI容器，設置斷點，并啟動調試會話。
通過以上步驟，你可以在Linux系統上成功部署和調試Swagger。 如有問題，請參考官方文檔。
