Swagger在Linux项目中如何部署 - 问答

在Linux项目中部署Swagger，通常是指安装和配置Swagger UI和Swagger Editor。以下是详细的步骤：

1. 安装Node.js和npm

首先，确保你的Linux系统上已经安装了Node.js和npm。你可以从Node.js官网下载并安装适合Linux的安装包。

# 下载Node.js
wget https://nodejs.org/dist/v14.17.0/node-v14.17.0-linux-x64.tar.xz

# 解压
tar -xvf node-v14.17.0-linux-x64.tar.xz

# 进入解压后的目录
cd node-v14.17.0-linux-x64

# 配置环境变量
sudo ln -s /usr/local/node-v14.17.0-linux-x64/bin/node /usr/local/bin/node
sudo ln -s /usr/local/node-v14.17.0-linux-x64/bin/npm /usr/local/bin/npm

# 验证安装
node -v
npm -v

2. 安装Express和其他必要的模块

# 全局安装Express
sudo npm install -g express

# 安装其他必要的模块
sudo npm install -g body-parser cookie-parser multer

3. 部署Swagger Editor

你可以通过Docker来快速部署Swagger Editor。

# 拉取Swagger Editor镜像
docker pull swaggerapi/swagger-editor:v4.6.0

# 运行Swagger Editor容器
docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0

访问http://your_server_ip:38080即可使用Swagger Editor。

4. 部署Swagger UI

同样，你可以通过Docker来部署Swagger UI。

# 拉取Swagger UI镜像
docker pull swaggerapi/swagger-ui:v4.15.5

# 运行Swagger UI容器
docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5

访问http://your_server_ip:38081即可使用Swagger UI。

5. 使用npm安装和部署Swagger UI（可选）

如果你不想使用Docker，也可以通过npm来安装和部署Swagger UI。

# 创建项目目录
mkdir -p /opt/swagger
cd /opt/swagger

# 初始化npm项目
npm init -y

# 安装Express
npm install express --save

# 安装其他必要的模块
npm install body-parser cookie-parser multer --save

# 创建index.js文件
cat <<EOF > index.js
var express = require('express');
var app = express();
app.use('/swagger', express.static('public'));
app.get('/', function (req, res) { res.send('Hello World'); });
var server = app.listen(3000, function () {
  var host = server.address().address;
  var port = server.address().port;
  console.log("应用实例,访问地址为 http://%s:%s", host, port);
});
EOF

# 创建public目录并复制Swagger UI文件
mkdir public
cd public
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz
tar -xvf v3.48.0.tar.gz
sudo cp -r swagger-ui-3.48.0/dist/* .

# 启动服务器
node index.js

访问http://your_server_ip:3000即可看到Swagger UI。

6. 配置Web服务器（可选）

如果你希望使用Apache或Nginx来提供Swagger UI和Swagger Editor，可以按照以下步骤进行配置。

使用Apache

# 安装Apache
sudo apt update
sudo apt install apache2

# 启用默认配置
sudo a2ensite default.conf
sudo systemctl restart apache2

使用Nginx

# 安装Nginx
sudo apt update
sudo apt install nginx

# 创建Nginx配置文件
sudo nano /etc/nginx/sites-available/default

# 添加以下内容
server {
  listen 80;
  server_name localhost;
  root /var/www/html;
  index index.html index.htm;

  location / {
    try_files $uri $uri/ /index.html;
  }
}

# 启用配置
sudo ln -s /etc/nginx/sites-available/default /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx

通过以上步骤，你就可以在Linux项目中成功部署Swagger UI和Swagger Editor。根据你的需求选择合适的部署方式即可。

0 赞

0 踩