ubuntu swagger使用教程

在Ubuntu上使用Swagger進行API文檔生成和測試，通常涉及安裝Swagger UI和Swagger Editor，然后配置和使用它們。以下是詳細的步驟：

安裝Node.js和npm

首先，確保你的系統上已經安裝了Node.js和npm。你可以通過以下命令來安裝：

sudo apt update
sudo apt install nodejs npm

安裝Swagger Editor

1. 下載Swagger Editor：

   訪問Swagger Editor的GitHub發布頁面，下載最新版本的Swagger Editor。

   wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz
   

2. 解壓并啟動Swagger Editor：

   tar -xvf v3.16.1.tar.gz
   cd swagger-editor-3.16.1
   npm install
   npm install -g http-server
   

3. 啟動Swagger Editor：

   http-server -p 8080
   

   現在，你可以在瀏覽器中訪問 http://localhost:8080 來使用Swagger Editor。

安裝Swagger UI

1. 下載Swagger UI：

   訪問Swagger UI的GitHub發布頁面，下載最新版本的Swagger UI。

   wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz
   

2. 解壓并啟動Swagger UI：

   tar -xvf v3.48.0.tar.gz
   cd swagger-ui-3.48.0
   npm install
   npm install -g http-server
   

3. 啟動Swagger UI：

   http-server -p 8081
   

   現在，你可以在瀏覽器中訪問 http://localhost:8081 來使用Swagger UI。

配置和使用Swagger Editor和Swagger UI

• Swagger Editor：默認情況下，Swagger Editor會加載 https://petstore.swagger.io/v2/swagger.json。你可以通過編輯 index.html 文件來更改默認的Swagger規范文件路徑。

• Swagger UI：在Swagger UI中，你可以通過輸入框來輸入你的Swagger規范文件（通常是 swagger.yaml 或 swagger.json）的URL，然后點擊“Explore”按鈕來加載和測試你的API接口。

使用Docker集成Swagger UI

1. 安裝Docker：

   sudo apt update
   sudo apt install docker.io
   

2. 拉取并運行Swagger UI Docker鏡像：

   docker pull swaggerapi/swagger-ui-express
   docker run -p 8080:8080 swaggerapi/swagger-ui-express
   

3. 訪問Swagger UI：

   在瀏覽器中訪問 http://localhost:8080，你應該能看到Swagger UI界面。

生成Swagger API文檔

1. 使用Swagger Editor生成API文檔：

   • 打開Swagger Editor后，點擊“File” - “Import” - “Open File”，然后選擇你的 swagger.yaml 或 swagger.json 文件。
   • 編輯和查看文檔。

2. 使用編程方式生成Swagger文檔：

   • 添加Swagger依賴。
   • 編寫API注解。
   • 配置Swagger生成器。
   • 運行項目，Swagger會自動生成API文檔。

3. 訪問Swagger UI查看生成的文檔：

   項目啟動后，訪問Swagger UI的端點（通常是 http://localhost:8080/swagger-ui.html），你應該能看到生成的API文檔。

以上步驟應該可以幫助你在Ubuntu上成功安裝和配置Swagger，并進行API文檔的查看和測試。如果在安裝過程中遇到問題，可以參考相關的官方文檔或社區論壇尋求幫助。