linux

Linux服务器上Swagger如何部署

小樊
87
2025-02-15 10:36:16
栏目: 云计算

在Linux服务器上部署Swagger,通常是指安装Swagger UI和Swagger Editor。以下是详细的安装步骤:

安装Swagger Editor

  1. 安装Node.js和npm

    sudo apt update
    sudo apt install -y openjdk-11-jre-headless
    
  2. 下载并解压Swagger Editor

    wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v4.6.0.tar.gz
    tar -xvf v4.6.0.tar.gz
    cd swagger-editor-4.6.0
    
  3. 启动Swagger Editor

    npm install
    nohup npm start &
    
  4. 访问Swagger Editor: 打开浏览器,访问 http://your_server_ip:8080 即可使用Swagger Editor。

安装Swagger UI

  1. 下载Swagger UI

    wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.html
    
  2. 解压Swagger UI

    unzip springfox-swagger-ui-2.9.2.html
    
  3. 配置Swagger UI: 编辑 index.html 文件,找到以下行并进行修改:

    <script>
      window.onload = function() {
        // Begin Swagger UI call region
        const ui = SwaggerUIBundle({
          url: "http://petstore.swagger.io/v2/api-docs",
          dom_id: '#swagger-ui',
          deepLinking: true,
          presets: [
            SwaggerUIBundle.presets.apis,
            SwaggerUIStandalonePreset
          ],
          plugins: [
            SwaggerUIBundle.plugins.DownloadUrl
          ],
          layout: "StandaloneLayout"
        });
        // End Swagger UI call region
        window.ui = ui;
      }
    </script>
    
  4. 启动Web服务器(例如Apache或Nginx)

    Apache

    sudo a2ensite default.conf
    sudo systemctl restart apache2
    

    Nginx

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

    修改 server 块中的 rootindex 指令:

    server {
      listen 80 default_server;
      listen [::]: 80 default_server;
      root /var/www/html;
      index index.html index.htm;
      server_name _;
      location / {
        try_files $uri $uri/ /index.html;
      }
    }
    

    保存并退出编辑器,然后重启Nginx:

    sudo systemctl restart nginx
    
  5. 访问Swagger UI: 打开浏览器,访问 http://your_server_ip:8081 即可使用Swagger UI。

通过以上步骤,你可以在Linux服务器上成功部署Swagger Editor和Swagger UI。

0
看了该问题的人还看了