如何測試Ubuntu Swagger API

在Ubuntu上測試Swagger API可以按照以下步驟進行：

安裝Node.js和npm

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

sudo apt update
sudo apt install nodejs npm

安裝Swagger Editor和Swagger UI

方法一：使用Docker

1. 安裝Docker（如果尚未安裝）：

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

2. 拉取并運行Swagger Editor：

   docker pull swaggerapi/swagger-editor:v4.6.0
   docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0
   

3. 拉取并運行Swagger UI：

   docker pull swaggerapi/swagger-ui:v4.15.5
   docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
   

4. 訪問Swagger Editor和Swagger UI：

   • Swagger Editor: http://localhost:38080
   • Swagger UI: http://localhost:38081

方法二：使用Node.js和Express

1. 安裝Node.js和npm（如果尚未安裝）：

   sudo apt update
   sudo apt install nodejs npm
   

2. 創建一個新的Node.js項目：

   mkdir swagger-ui-project
   cd swagger-ui-project
   npm init -y
   

3. 安裝Swagger UI Express：

   npm install swagger-ui-express
   

4. 創建一個簡單的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}`);
   });
   

5. 創建Swagger文檔（創建一個名為 swagger.yaml 的文件，并添加你的API文檔）：

   swagger: '2.0'
   info:
     title: Sample API
     description: A sample API to demonstrate Swagger UI on Ubuntu
     version: '1.0.0'
     host: localhost:3000
     basePath: /api
   schemes:
     - http
   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
           format: int64
         name:
           type: string
         email:
           type: string
           format: email
   

6. 運行應用：

   node app.js
   

7. 訪問Swagger UI：

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

使用Swagger進行接口測試

1. 在Swagger Editor中導入Swagger規范文件：

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

2. 測試API接口：

   • 在Swagger Editor中，你可以為每個API接口生成測試用例，也可以直接調用這些接口進行測試。
   • 在Swagger UI中，選擇你要測試的API接口，點擊“Try it out!”按鈕，然后在彈出的對話框中輸入必要的參數，最后點擊“Execute”按鈕來測試接口。

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