如何在Ubuntu上部署Swagger UI

4月 27th, 2025

在Ubuntu上部署Swagger UI，你可以遵循以下步骤：

安装Node.js和npm：
Swagger UI通常是通过Node.js运行的，所以首先你需要安装Node.js和npm（Node.js的包管理器）。你可以使用以下命令来安装它们：
```
sudo apt update
sudo apt install nodejs npm
```
为了确保npm是最新的，你可以运行：
```
sudo npm install -g npm
```
安装Swagger UI Express：
Swagger UI Express是一个可以让你轻松地在Express应用中集成Swagger UI的库。使用npm安装它：
```
npm install swagger-ui-express
```

创建一个简单的Express应用：
创建一个新的目录来存放你的Swagger UI应用，并在该目录中创建一个名为app.js的文件。在这个文件中，你可以设置一个简单的Express服务器，并集成Swagger UI：

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

在这个例子中，我们使用yamljs库来加载Swagger文档（你需要创建一个swagger.yaml文件来描述你的API）。

安装YAML解析库：
由于我们在上面的代码中使用了yamljs来加载Swagger文档，我们需要安装这个库：
```
npm install yamljs
```
创建Swagger文档：
创建一个名为swagger.yaml的文件，并按照Swagger规范填写你的API信息。
运行你的应用：
在终端中，切换到你的应用目录，并运行以下命令来启动服务器：
```
node app.js
```
访问Swagger UI：
打开浏览器并访问http://localhost:3000/api-docs，你应该能够看到Swagger UI界面，其中展示了你的API文档。