溫馨提示×

如何在Linux上部署Swagger UI界面

小樊
72
2025-04-03 01:51:50
欄目: 智能運維

在Linux上部署Swagger UI界面,可以按照以下步驟進行:

方法一:使用Docker

  1. 安裝Docker: 如果你還沒有安裝Docker,請先安裝它??梢允褂靡韵旅顏戆惭bDocker:

    sudo apt update
    sudo apt install docker.io
    
  2. 拉取Swagger UI鏡像: 使用以下命令從Docker Hub拉取Swagger UI的鏡像:

    docker pull swaggerapi/swagger-ui-express
    
  3. 運行Swagger UI容器: 使用以下命令啟動一個Swagger UI容器,并將其映射到本地的端口(例如8080):

    docker run -p 8080:8080 -e SWAGGER_JSON=/app/swagger.json -v /path/to/swagger.json:/app/swagger.json swaggerapi/swagger-ui-express
    

    其中,/path/to/swagger.json是你本地Swagger JSON文件的路徑。

  4. 訪問Swagger UI: 打開瀏覽器,訪問http://localhost:8080,你應該能夠看到Swagger UI界面。

方法二:手動部署

  1. 安裝Node.js和npm: 如果你還沒有安裝Node.js和npm,請先安裝它們??梢允褂靡韵旅顏戆惭b:

    sudo apt update
    sudo apt install nodejs npm
    
  2. 創建項目目錄: 創建一個新的項目目錄,并進入該目錄:

    mkdir swagger-ui-project
    cd swagger-ui-project
    
  3. 初始化npm項目: 初始化一個新的npm項目:

    npm init -y
    
  4. 安裝Swagger UI Express: 安裝Swagger UI Express庫:

    npm install swagger-ui-express
    
  5. 創建服務器文件: 創建一個名為server.js的文件,并添加以下代碼:

    const express = require('express');
    const swaggerUi = require('swagger-ui-express');
    const YAML = require('yamljs');
    
    // Load Swagger document
    const swaggerDocument = YAML.load('./swagger.yaml');
    
    const app = express();
    
    // Serve Swagger docs
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
    
    const PORT = process.env.PORT || 3000;
    app.listen(PORT, () => {
      console.log(`Server is running on port ${PORT}`);
    });
    
  6. 準備Swagger JSON文件: 確保你有一個Swagger JSON文件(例如swagger.yaml),并將其放在項目目錄中。

  7. 啟動服務器: 使用以下命令啟動服務器:

    node server.js
    
  8. 訪問Swagger UI: 打開瀏覽器,訪問http://localhost:3000/api-docs,你應該能夠看到Swagger UI界面。

通過以上兩種方法,你可以在Linux上成功部署Swagger UI界面。選擇適合你的方法進行操作即可。

0
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女