如何测试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

安装Docker（如果尚未安装）：

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

拉取并运行Swagger Editor：

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

拉取并运行Swagger UI：

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

访问Swagger Editor和Swagger UI：
- Swagger Editor: http://localhost:38080
- Swagger UI: http://localhost:38081

方法二：使用Node.js和Express

安装Node.js和npm（如果尚未安装）：
```
sudo apt update
sudo apt install nodejs npm
```

创建一个新的Node.js项目：

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

安装Swagger UI Express：
```
npm install swagger-ui-express
```

创建一个简单的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}`);
});

创建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

运行应用：
```
node app.js
```
访问Swagger UI：

打开浏览器并访问 http://localhost:3000/api-docs，你应该能看到Swagger UI界面。

使用Swagger进行接口测试

在Swagger Editor中导入Swagger规范文件：
- 打开Swagger Editor后，点击“File” - “Import” - “Open File”，然后选择你的 swagger.yaml 或 swagger.json 文件。
测试API接口：
- 在Swagger Editor中，你可以为每个API接口生成测试用例，也可以直接调用这些接口进行测试。
- 在Swagger UI中，选择你要测试的API接口，点击“Try it out!”按钮，然后在弹出的对话框中输入必要的参数，最后点击“Execute”按钮来测试接口。

通过以上步骤，你就可以在Ubuntu上成功安装和配置Swagger，并进行API的测试。如果在安装过程中遇到问题，可以参考相关的官方文档或社区论坛寻求帮助。

0 赞

0 踩