如何使用Swagger在Ubuntu上测试API

2025年7月5日 互联网

要在Ubuntu上使用Swagger测试API，请按照以下步骤操作：

  1. 安装Swagger UI：首先，您需要在Ubuntu系统上安装Swagger UI。打开终端并运行以下命令：
sudo apt-get update
sudo apt-get install swagger-ui-express
  1. 创建一个简单的Express应用：在您的项目文件夹中创建一个名为app.js的文件，并添加以下代码：
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');

const app = express();
const port = process.env.PORT || 3000;

// 读取Swagger JSON文件
const swaggerDocument = YAML.load('./swagger.json');

// 使用swagger-ui-express中间件
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

// 启动服务器
app.listen(port, () => {
  console.log(`Server is running at http://localhost:${port}`);
});
  1. 创建Swagger JSON文件：在项目文件夹中创建一个名为swagger.json的文件，其中包含您的API规范。例如：
{
  "swagger": "2.0",
  "info": {
    "description": "Sample API",
    "version": "1.0.0"
  },
  "basePath": "/",
  "paths": {
    "/users": {
      "get": {
        "summary": "获取用户列表",
        "responses": {
          "200": {
            "description": "成功获取用户列表"
          }
        }
      }
    }
  }
}
  1. 安装依赖项：在项目文件夹中运行以下命令，以安装所需的依赖项：
npm init -y
npm install express yamljs
  1. 运行应用：在终端中运行以下命令，启动Express应用：
node app.js
  1. 访问Swagger UI：在浏览器中访问http://localhost:3000/api-docs，您将看到Swagger UI界面，其中显示了您的API规范。您可以在此界面上测试API端点。

注意：这只是一个简单的示例，您可以根据需要修改Swagger JSON文件以匹配您的API规范。在实际项目中，您可能需要使用更复杂的API规范和更多的端点。

最新文章