如何在Linux系统上部署Swagger在线文档

linux

小樊

2025-10-05 10:53:25

栏目: 智能运维

在Linux系统上部署Swagger在线文档，可以按照以下步骤进行：

1. 安装Node.js和npm

Swagger UI通常是通过Node.js和npm来运行的。首先，确保你的Linux系统上已经安装了Node.js和npm。

# 更新包列表
sudo apt update

# 安装Node.js和npm
sudo apt install nodejs npm

# 验证安装
node -v
npm -v

2. 创建项目目录

mkdir swagger-ui
cd swagger-ui

3. 初始化npm项目

初始化一个新的npm项目。

npm init -y

4. 安装Swagger UI Express

安装Swagger UI Express，这是一个用于展示Swagger文档的Express中间件。

npm install swagger-ui-express

5. 创建Swagger文档

创建一个Swagger文档文件（例如swagger.json），并定义你的API规范。

{
  "swagger": "2.0",
  "info": {
    "description": "Sample API",
    "version": "1.0.0"
  },
  "paths": {
    "/api/hello": {
      "get": {
        "summary": "Get a hello message",
        "responses": {
          "200": {
            "description": "A simple hello message"
          }
        }
      }
    }
  }
}

6. 创建Express应用

创建一个Express应用，并集成Swagger UI Express。

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

const app = express();

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

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

7. 运行应用

使用Node.js运行你的Express应用。

node app.js

8. 访问Swagger UI

打开浏览器，访问http://<your-server-ip>:3000/api-docs，你应该能够看到Swagger UI界面，并查看你的API文档。

9. 部署到生产环境（可选）

如果你希望将应用部署到生产环境，可以使用PM2来管理Node.js进程。

# 安装PM2
sudo npm install pm2 -g

# 启动应用
pm2 start app.js --name swagger-ui

# 查看应用状态
pm2 status

# 停止应用
pm2 stop swagger-ui

# 删除应用
pm2 delete swagger-ui

通过以上步骤，你可以在Linux系统上成功部署Swagger在线文档。