ubuntu中如何调试swagger接口

发布时间:2025-07-07 07:08:37

阅读量:29

在Ubuntu系统中调试Swagger接口，你可以遵循以下步骤：

安装Swagger UI：首先，你需要在你的Ubuntu系统上安装Swagger UI。你可以使用npm（Node.js包管理器）来安装它。如果你还没有安装Node.js，请先安装它。打开终端，然后运行以下命令：

sudo apt update
sudo apt install nodejs npm

接下来，使用npm全局安装Swagger UI：

sudo npm install -g swagger-ui-express

创建一个简单的Express应用：在你的项目文件夹中创建一个名为app.js的文件，并添加以下代码：

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');

const app = express();

// 读取Swagger文档
const swaggerDocument = YAML.load('./swagger.yaml');

// 使用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 at http://localhost:${port}`);
});

创建Swagger文档：在项目文件夹中创建一个名为swagger.yaml的文件，并添加你的API接口定义。例如：

swagger: '2.0'
info:
  title: Sample API
  description: A sample API to demonstrate Swagger UI.
  version: '1.0.0'
host: localhost:3000
basePath: /api-docs
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