Swagger UI在Linux上如何運行

在Linux上運行Swagger UI可以通過多種方式實現，以下是兩種常見的方法：使用Docker容器部署和手動安裝。

使用Docker容器部署

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

   sudo apt update
   sudo apt install -y docker.io
   sudo systemctl start docker
   sudo systemctl enable docker
   

2. 拉取Swagger UI鏡像： 使用以下命令從Docker Hub拉取Swagger UI的鏡像：

   docker pull swaggerapi/swagger-ui-express
   

3. 運行Swagger UI容器： 使用以下命令啟動一個Swagger UI容器，并將你的API文檔掛載到容器中。假設你的API文檔位于/path/to/swagger.json：

   docker run -p 8080:8080 -v /path/to/swagger.json:/usr/src/app/swagger.json swaggerapi/swagger-ui-express
   

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

手動安裝

1. 安裝Node.js和npm： 如果你還沒有安裝Node.js和npm，請先安裝它們?？梢允褂靡韵旅畎惭b：

   curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
   sudo apt-get install -y nodejs
   

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文檔： 創建一個名為swagger.yaml的文件，并添加你的API文檔。例如：

   swagger: '2.0'
   info:
     title: Sample API
     description: A sample API to demonstrate Swagger UI
     version: '1.0.0'
   paths:
     /users:
       get:
         summary: List all users
         responses:
           '200':
             description: An array of users
         schema:
           type: array
           items:
             $ref: '#/definitions/User'
   definitions:
     User:
       type: object
       properties:
         id:
           type: integer
         name:
           type: string
   

7. 啟動服務器： 在終端中，導航到你的項目目錄，并運行以下命令來啟動你的Express服務器：

   node server.js
   

8. 訪問Swagger UI： 打開瀏覽器，訪問http://localhost:3000/api-docs，你應該能夠看到Swagger UI界面，其中展示了你的API文檔，并允許你進行交互式測試。

這兩種方法都可以幫助你在Linux上部署Swagger UI。選擇哪種方法取決于你的具體需求和環境。