Linux下Swagger如何實現跨平臺兼容

在Linux系統下，Swagger（現稱為OpenAPI）可以通過多種方式實現跨平臺兼容，以下是詳細的步驟和建議：

1. 安裝Swagger Editor和Swagger UI：

   • 安裝Swagger Editor：可以通過下載Swagger Editor的Docker鏡像并在本地運行來實現跨平臺兼容。具體步驟如下：

     1. 拉取Swagger Editor的Docker鏡像：

     docker pull swaggerapi/swagger-editor
     

     2. 運行容器并將容器的8080端口映射到宿主機的8080端口：

     docker run -p 8080:8080 swaggerapi/swagger-editor
     

     3. 在瀏覽器中訪問 http://localhost:8080 即可使用Swagger Editor。

   • 安裝Swagger UI：可以通過以下步驟在Linux上安裝Swagger UI：

     1. 更新包列表：

        sudo apt update
        

     2. 安裝必要的依賴：

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

     3. 下載并解壓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
        

     4. 將解壓后的文件移動到Web服務目錄（例如/var/www/html）：

        sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui
        

     5. 配置Swagger UI：編輯/var/www/html/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
        

     6. 啟動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塊中的root和index指令：

          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/ =404;
            }
          }
          

          保存并退出編輯器，然后重啟Nginx：

          sudo systemctl restart nginx
          

     7. 通過瀏覽器訪問 http://your_server_ip/swagger-ui 即可查看和使用Swagger UI。

2. 配置和部署：

   • 配置文件：在Swagger的配置文件（如application.properties或application.yml）中，設置springfox.documentation.swagger.v2.host為0.0.0.0，以允許所有IP地址訪問Swagger接口文檔。
   • 網絡要求：確保服務器的防火墻允許訪問Swagger UI所在的端口。例如，如果Swagger UI運行在8080端口，需要確保防火墻允許從外部訪問該端口。

3. 跨平臺兼容的優勢：

   • Docker容器化部署：通過Docker容器化部署Swagger，可以實現遠程訪問和團隊協作編輯，從而提高開發效率。
   • 多種文檔格式：Swagger支持多種文檔格式和編程語言，如HTML、PDF、Markdown以及Java、Scala、Spring等，方便開發者根據需求選擇合適的格式進行文檔的生成和分享。

通過以上步驟和建議，可以在Linux系統下實現Swagger的跨平臺兼容，確保在不同平臺上都能順利使用和管理API文檔。