温馨提示×

如何在Debian上部署Swagger UI

小樊
37
2025-03-18 19:25:58
栏目: 智能运维

在Debian上部署Swagger UI可以通过多种方式实现,以下是使用Docker和Nginx两种常见方法的步骤:

方法一:使用Docker部署Swagger UI

  1. 安装Docker: 如果你还没有安装Docker,请先安装它。可以使用以下命令:

    sudo apt update
    sudo apt install docker.io
    
  2. 拉取Swagger UI镜像: 使用Docker Hub上的Swagger UI镜像:

    docker pull swaggerapi/swagger-ui
    
  3. 运行Swagger UI容器: 运行一个容器并映射端口(例如8080):

    docker run -p 8080:8080 -d swaggerapi/swagger-ui
    
  4. 访问Swagger UI: 打开浏览器并访问 http://<your-debian-ip>:8080,你应该能看到Swagger UI界面。

方法二:使用Nginx和Swagger UI静态文件部署

  1. 安装Nginx: 如果你还没有安装Nginx,请先安装它:

    sudo apt update
    sudo apt install nginx
    
  2. 下载Swagger UI静态文件: 你可以从Swagger UI的GitHub仓库下载静态文件,或者使用以下命令直接下载:

    wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui-bundle.js
    wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui-standalone-preset.js
    wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui.css
    wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui-extensions.css
    
  3. 创建一个目录来存放Swagger UI文件

    sudo mkdir -p /var/www/swagger-ui
    sudo cp swagger-ui-bundle.js swagger-ui-standalone-preset.js swagger-ui.css swagger-ui-extensions.css /var/www/swagger-ui/
    
  4. 配置Nginx: 编辑Nginx配置文件 /etc/nginx/sites-available/default,添加以下内容:

    server {
        listen 80;
        server_name <your-debian-ip>;
    
        location /swagger-ui/ {
            root /var/www/swagger-ui;
            try_files $uri $uri/ /swagger-ui/index.html;
        }
    }
    
  5. 重启Nginx

    sudo systemctl restart nginx
    
  6. 访问Swagger UI: 打开浏览器并访问 http://<your-debian-ip>/swagger-ui/,你应该能看到Swagger UI界面。

方法三:使用Swagger Codegen生成静态文件

  1. 安装Swagger Codegen: 你可以使用以下命令安装Swagger Codegen:

    wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.21/swagger-codegen-cli-2.4.21.jar
    sudo mv swagger-codegen-cli-2.4.21.jar /usr/local/bin/swagger-codegen
    sudo chmod +x /usr/local/bin/swagger-codegen
    
  2. 生成Swagger UI静态文件: 使用Swagger Codegen生成静态文件:

    swagger-codegen generate -i <path-to-your-swagger-spec> -l static -o /var/www/swagger-ui
    
  3. 配置Nginx: 参考方法二中的Nginx配置步骤。

  4. 重启Nginx

    sudo systemctl restart nginx
    
  5. 访问Swagger UI: 打开浏览器并访问 http://<your-debian-ip>/swagger-ui/,你应该能看到Swagger UI界面。

选择适合你的方法进行部署即可。

0