溫馨提示×

Linux系統中Swagger的安裝步驟是什么

小樊
85
2025-03-07 23:59:37
欄目: 智能運維

在Linux系統中安裝Swagger,通常是指安裝Swagger UI和Swagger Editor。以下是詳細的安裝步驟:

安裝Swagger Editor

  1. 安裝Node.js和npm

    • 更新包列表:
      sudo apt update
      
    • 安裝必要的依賴:
      sudo apt install -y openjdk-11-jre-headless
      
    • 下載并安裝Node.js和npm:
      wget https://nodejs.org/dist/v16.14.0/node-v16.14.0-linux-x64.tar.xz
      tar -xvf node-v16.14.0-linux-x64.tar.xz
      sudo mv node-v16.14.0-linux-x64 /usr/local/nodejs
      
    • 配置Node.js和npm全局路徑:
      echo 'export PATH=/usr/local/nodejs/bin:$PATH' >> ~/.bashrc
      source ~/.bashrc
      
    • 驗證安裝:
      node -v
      npm -v
      
  2. 下載并安裝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 /usr/local/nodejs/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>
      
    • 啟動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 /usr/local/nodejs;
            index index.html index.htm;
            server_name _;
            location / {
                try_files $uri $uri/ =404;
            }
        }
        
        保存并退出編輯器,然后重啟Nginx:
        sudo systemctl restart nginx
        
  3. 訪問Swagger Editor

    • 打開瀏覽器,訪問:
      http://your_server_ip/swagger-editor
      

安裝Swagger UI(適用于Spring Boot項目)

  1. 添加依賴

    • 在項目的pom.xml文件中添加以下依賴:
      <dependencies>
          <dependency>
              <groupId>io.springfox</groupId>
              <artifactId>springfox-swagger2</artifactId>
              <version>2.9.2</version>
          </dependency>
          <dependency>
              <groupId>io.springfox</groupId>
              <artifactId>springfox-swagger-ui</artifactId>
              <version>2.9.2</version>
          </dependency>
          <!-- 其他依賴 -->
      </dependencies>
      
  2. 配置Swagger

    • 創建一個配置類來啟用Swagger并定義一些基本信息:
      import org.springframework.context.annotation.Bean;
      import org.springframework.context.annotation.Configuration;
      import springfox.documentation.builders.PathSelectors;
      import springfox.documentation.builders.RequestHandlerSelectors;
      import springfox.documentation.spi.DocumentationType;
      import springfox.documentation.spring.web.plugins.Docket;
      import springfox.documentation.swagger2.annotations.EnableSwagger2;
      
      @Configuration
      @EnableSwagger2
      public class SwaggerConfig {
          @Bean
          public Docket api() {
              return new Docket(DocumentationType.SWAGGER_2)
                      .select()
                      .apis(RequestHandlerSelectors.any())
                      .paths(PathSelectors.any())
                      .build();
          }
      }
      
  3. 訪問Swagger UI

    • 啟動Spring Boot項目后,訪問:
      http://localhost:8080/swagger-ui.html
      

通過以上步驟,你可以在Linux系統中成功安裝并配置Swagger UI和Swagger Editor。

0
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女