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。选择适合你的方法进行操作即可。