Ubuntu中Swagger如何調試

在Ubuntu中調試Swagger可按以下步驟操作：

1. 安裝基礎環境
   確保已安裝Node.js和npm，若未安裝可使用命令：

   sudo apt update  
   sudo apt install -y nodejs npm  
   

2. 安裝Swagger工具

   • 安裝Swagger Editor（用于編寫和調試API文檔）：

     npm install -g swagger-editor-cli  
     

   • 安裝Swagger UI（用于接口測試）：

     npm install -g swagger-ui-express  
     

3. 配置Swagger

   • 編輯Swagger Editor的index.html文件，指定本地Swagger規范文件路徑（如swagger.yaml/swagger.json）。
   • 在Swagger UI中，通過輸入框加載本地或遠程的Swagger規范文件URL，點擊“Explore”加載接口。

4. 啟動調試

   • 啟動Swagger Editor：進入項目目錄，運行npm start，默認在端口3000運行，可通過瀏覽器訪問http://localhost:3000。
   • 啟動Swagger UI：若通過Express集成，運行node app.js，訪問http://localhost:3000/api-docs。

5. 接口測試與調試

   • 在Swagger Editor中直接調用接口測試，或通過Swagger UI的“Try it out!”按鈕輸入參數測試。
   • 若需高級調試，可在Visual Studio Code中配置launch.json，通過node --inspect-brk app.js啟動調試模式，設置斷點查看變量和執行流程。

6. 常見問題處理

   • 防火墻攔截：若無法訪問，檢查防火墻規則，允許對應端口（如sudo ufw allow 3000）。
   • 配置文件錯誤：確保swagger-config.yaml路徑正確，或直接編輯swagger.json/swagger.yaml文件。

參考來源：