Ubuntu Swagger如何測試API

在Ubuntu上測試API，通常是通過安裝和配置Swagger（現在通常指的是OpenAPI Generator或Swagger UI）來實現的。以下是詳細的步驟：

安裝Swagger

方法一：使用npm安裝Swagger UI

1. 更新系統包列表：

sudo apt update

2. 安裝Node.js和npm：

sudo apt install nodejs npm

3. 全局安裝Swagger UI：

sudo npm install -g swagger-ui-express

4. 創建一個簡單的Express應用并集成Swagger UI：

   • 創建一個新的目錄并進入該目錄：

   mkdir swagger-demo
   cd swagger-demo
   

   • 創建一個 index.js 文件，并添加以下內容：

   const express = require('express');
   const swaggerUi = require('swagger-ui-express');
   const YAML = require('yamljs');
   
   // 讀取Swagger文檔
   const swaggerDocument = YAML.load('./swagger.yaml');
   
   const app = express();
   
   // 使用swagger-ui-express中間件
   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} /api-docs`);
   });
   

   • 創建一個 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
   

5. 啟動應用：

node index.js

6. 訪問Swagger UI： 在瀏覽器中訪問 http://localhost:3000/api-docs 來查看Swagger UI界面，并與你的API進行交互。

方法二：使用Docker安裝Swagger

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

sudo apt update
sudo apt install docker.io

2. 拉取Swagger UI鏡像：

docker pull swaggerapi/swagger-ui:v4.15.5

3. 運行Swagger UI容器：

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

4. 訪問Swagger UI： 打開瀏覽器并訪問 http://localhost:38081/swagger-ui.html，查看和測試你的API接口。

安全性考慮

• 禁用文檔或限制訪問：在生產環境中關閉Swagger，或通過Nginx配置IP白名單，僅允許內部IP訪問。
• 強制認證與參數校驗：在Swagger中集成API Key或OAuth2認證，拒絕未授權調用。
• 持續監控與響應：用AWVS、Nessus定期掃描Swagger路徑，或用Python腳本主動探測。

通過以上步驟，你可以在Ubuntu系統中成功安裝并使用Swagger工具來測試API。選擇適合你的方法進行操作即可。