在Linux系统中Swagger UI如何部署 - 问答

在Linux系统中部署Swagger UI可以通过多种方法实现，以下是几种常见的方法：

使用Docker容器部署Swagger UI

安装Docker：如果你还没有安装Docker，请先安装它。可以使用以下命令安装Docker：
```
sudo apt update
sudo apt install docker.io
sudo systemctl start docker
sudo systemctl enable docker
```
拉取Swagger UI镜像：使用以下命令从Docker Hub拉取Swagger UI的镜像：
```
docker pull swaggerapi/swagger-ui:latest
```
运行Swagger UI容器：使用以下命令启动一个Swagger UI容器，并将其映射到本地的端口（例如8080）：
```
docker run -d -p 8080:8080 -e SWAGGER_JSON=/app/swagger.json -v $(pwd):/app swaggerapi/swagger-ui-express
```
确保你的swagger.json文件位于当前目录中。
访问Swagger UI：打开浏览器，访问 http://localhost:8080，你应该能够看到Swagger UI界面。

使用npm和http-server手动部署

安装Node.js和npm：如果你还没有安装Node.js和npm，请先安装它们：
```
sudo apt update
sudo apt install nodejs npm
```
创建项目目录：创建一个新的项目目录并进入该目录：
```
mkdir swagger-ui-project
cd swagger-ui-project
```
初始化npm项目：初始化一个新的npm项目：
```
npm init -y
```
安装Swagger UI Express：安装Swagger UI Express库：
```
npm install swagger-ui-express
```

创建服务器文件：创建一个名为 server.js 的文件，并添加以下代码：

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 on port ${PORT}`);
});

准备Swagger JSON文件：确保你有一个Swagger JSON文件（例如 swagger.yaml），并将其放在项目目录中。
启动服务器：使用以下命令启动服务器：
```
node server.js
```
访问Swagger UI：打开浏览器，访问 http://localhost:3000/api-docs，你应该能够看到Swagger UI界面。

使用Apache或Nginx部署

安装Apache或Nginx：如果你使用的是Ubuntu系统，可以参考以下命令安装：
```
sudo apt update
sudo apt install -y apache2
```
或者
```
sudo apt install -y nginx
```

下载并解压Swagger UI：下载Swagger UI：

wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.html
unzip springfox-swagger-ui-2.9.2.html
sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui

配置Web服务器：

Apache：

sudo a2ensite default.conf
sudo systemctl restart apache2

Nginx：修改 /etc/nginx/sites-available/default 文件：

sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup
sudo nano /etc/nginx/sites-available/default

保存并退出编辑器，然后重启Nginx：

sudo systemctl restart nginx

访问Swagger UI：现在，你应该能够通过浏览器访问 http://your_server_ip/swagger-ui 来查看和使用Swagger UI。

通过以上方法，你可以在Linux系统上成功部署Swagger UI。选择适合你的方法进行操作即可。

0 赞

0 踩