Ubuntu Swagger如何實現API文檔的在線預覽

在Ubuntu上實現Swagger API文檔的在線預覽，可以通過以下幾種方法：

方法一：使用Docker

1. 安裝Docker： 如果你還沒有安裝Docker，可以使用以下命令安裝：

sudo apt update
sudo apt install docker.io

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

docker pull swaggerapi/swagger-ui-express

3. 運行Swagger UI容器： 運行一個容器并映射端口（例如8080）：

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

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

方法二：使用Node.js和Express

1. 安裝Node.js和npm： 如果你還沒有安裝Node.js和npm，可以使用以下命令安裝：

sudo apt update
sudo apt install nodejs npm

2. 創建一個新的Node.js項目： 創建一個新的目錄并進入該目錄：

mkdir swagger-ui-project
cd swagger-ui-project

3. 初始化npm項目：

npm init -y

4. 安裝Swagger UI Express：

npm install swagger-ui-express

5. 創建一個簡單的Express應用： 創建一個名為 app.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 integration
  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. 運行應用：

node app.js

8. 訪問Swagger UI： 打開瀏覽器并訪問 http://localhost:3000/api-docs，你應該能看到Swagger UI界面。

方法三：使用Swagger Editor和Swagger UI

1. 安裝Node.js和npm： 確保你的系統上已經安裝了Node.js和npm?？梢酝ㄟ^以下命令安裝：

sudo apt update
sudo apt install nodejs npm

2. 安裝Swagger Editor： 可以從官網下載并解壓Swagger Editor，或者使用npm全局安裝：

npm install -g swagger-editor

3. 安裝Swagger UI： 可以從官網下載并解壓Swagger UI，或者使用npm全局安裝：

npm install -g swagger-ui

4. 配置Swagger Editor和Swagger UI：

• Swagger Editor配置：啟動Swagger Editor后，訪問 http://localhost:8080，使用你保存的Swagger YAML文件進行API文檔的編輯和查看。
• Swagger UI配置：啟動Swagger UI后，訪問 http://localhost:3000，在頁面中輸入你的Swagger YAML文件的URL，然后點擊“Explore”按鈕查看和測試API。

通過以上方法，你可以在Ubuntu上成功集成Swagger UI，并實現在線預覽API文檔。