Swagger如何在Linux服务器上进行部署

303
2025/3/26 6:32:56
栏目: 云计算
开发者测试专用服务器限时活动,0元免费领,库存有限,领完即止! 点击查看>>

在Linux服务器上部署Swagger主要分为几个步骤,包括安装必要的软件、下载Swagger UI和Swagger Editor、配置Web服务器以及启动服务。以下是详细的步骤指南:

1. 安装Node.js和npm

首先,需要在Linux服务器上安装Node.js和npm。可以通过以下命令进行安装:

sudo apt update
sudo apt install -y openjdk-11-jre-headless

2. 下载并安装Swagger UI

可以从Swagger的官方GitHub仓库下载Swagger UI:

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install

3. 配置Swagger UI

将构建好的Swagger UI文件复制到Web服务器的目录中,例如 /var/www/html

sudo cp -r target/swagger-ui-dist/* /var/www/html/

4. 配置Web服务器

使用Apache

如果使用Apache,可以创建一个虚拟主机配置文件:

sudo nano /etc/apache2/sites-available/swagger.conf

添加以下内容:

<VirtualHost *:80>
    ServerName localhost
    DocumentRoot /var/www/html
    <Directory /var/www/html>
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
</VirtualHost>

然后启用该虚拟主机并重启Apache:

sudo a2ensite swagger.conf
sudo systemctl reload apache2

使用Nginx

如果使用Nginx,可以创建一个服务器块配置文件:

sudo nano /etc/nginx/sites-available/swagger

添加以下内容:

server {
    listen 80;
    server_name localhost;
    root /var/www/html;
    index index.html index.htm;

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

然后启用该服务器块并重启Nginx:

sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx

5. 启动Swagger Editor(可选)

如果需要本地访问Swagger Editor,可以下载并安装:

wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.js
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.css

创建一个简单的HTML文件来加载Swagger Editor:

sudo nano /var/www/html/swagger-editor.html

添加以下内容:

<!DOCTYPE html>
<html>
<head>
    <link rel="stylesheet" type="text/css" href="swagger-editor.min.css">
</head>
<body>
    <div id="swagger-editor"></div>
    <script src="swagger-editor.min.js"></script>
    <script>
        window.onload = function() {
            const editor = SwaggerEditor({
                url: "https://petstore.swagger.io/v2/api-docs",
                dom_id: '#swagger-editor'
            });
        };
    </script>
</body>
</html>

6. 访问Swagger UI

打开浏览器,访问以下URL来查看和使用Swagger UI:

  • Swagger UI: http://your_server_ip/swagger-ui
  • Swagger Editor: http://your_server_ip/swagger-editor

以上步骤应该能够帮助你在Linux服务器上成功部署Swagger。如果在配置过程中遇到问题,请检查服务器的防火墙设置,确保相关端口(如80、443等)是开放的。

辰迅云「云服务器」,即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘,价格低至29元/月。点击查看>>

推荐阅读: Linux Web服务器如何进行灾难恢复