如何在Linux服务器上运行Swagger

2025年8月22日 互联网

在Linux服务器上运行Swagger，通常是指使用Swagger UI来展示和测试你的API。Swagger UI是一个可视化的工具，它允许用户查看RESTful API的文档，并直接从界面上发送请求。以下是在Linux服务器上运行Swagger UI的一般步骤：

  1. 安装Node.js和npm：
    Swagger UI可以通过Node.js来运行。首先，你需要在你的Linux服务器上安装Node.js和npm（Node.js的包管理器）。你可以使用以下命令来安装它们：

    curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

    这里我们安装的是Node.js的14.x版本，你可以根据需要选择其他版本。

  2. 安装Swagger UI Express：
    Swagger UI可以通过npm安装为Node.js的一个模块。在你的服务器上创建一个新的目录，并在该目录中运行以下命令来安装Swagger UI Express：

    mkdir swagger-ui-express
cd swagger-ui-express
npm init -y
npm install swagger-ui-express

  3. 下载Swagger JSON文件：
    你需要有一个Swagger定义文件（通常是YAML或JSON格式），这个文件描述了你的API。你可以手动编写这个文件，或者使用Swagger工具从你的代码中生成。将这个文件保存在你的项目目录中，例如命名为swagger.json。

  4. 设置Swagger UI Express服务器：
    在你的项目目录中创建一个名为app.js的文件，并添加以下代码来设置Swagger UI Express服务器：

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

// Load Swagger document
const swaggerDocument = YAML.load('./swagger.json');

const app = express();

// Serve Swagger docs
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`Server is running at http://localhost:${PORT}/api-docs`);
});

    这段代码会启动一个Express服务器，并在/api-docs路径下提供Swagger UI界面。

  5. 运行服务器：
    在终端中运行以下命令来启动你的服务器：

    node app.js

    服务器启动后，你可以在浏览器中访问http://:8080/api-docs来查看和测试你的API。

  6. （可选）使用PM2管理Node.js应用：
    为了确保你的Swagger UI Express服务器能够在后台运行，甚至在关闭终端后也能继续运行，你可以使用PM2这样的进程管理器。首先安装PM2：

    npm install pm2 -g

    然后使用PM2启动你的应用：

    pm2 start app.js --name swagger-ui

    PM2会帮助你管理Node.js应用的生命周期，并提供日志管理、性能监控等功能。

以上步骤是在Linux服务器上运行Swagger UI的基本流程。根据你的具体需求，可能还需要进行一些额外的配置和优化。

最新文章