Swagger在Linux環境下如何配置

在Linux環境下配置Swagger，通常是指安裝和配置Swagger UI和Swagger Editor。以下是詳細的步驟：

安裝Swagger UI和Swagger Editor

使用Docker容器部署

1. 安裝Docker（如果尚未安裝）：

   sudo apt-get update
   sudo apt-get install -y docker.io
   sudo systemctl start docker
   sudo systemctl enable docker
   

2. 拉取Swagger UI鏡像：

   docker pull swaggerapi/swagger-ui:v4.6.0
   

3. 拉取Swagger Editor鏡像：

   docker pull swaggerapi/swagger-editor:v4.6.0
   

4. 運行Swagger UI容器：

   docker run -d -p 38080:8080 swaggerapi/swagger-ui:v4.6.0
   

5. 運行Swagger Editor容器：

   docker run -d -p 38081:8080 swaggerapi/swagger-editor:v4.6.0
   

   現在，你可以通過訪問 http://<your-server-ip>:38080 來查看Swagger UI，通過訪問 http://<your-server-ip>:38081 來查看Swagger Editor。

使用npm安裝

1. 安裝Node.js和npm（如果尚未安裝）：

   curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
   sudo apt-get install -y nodejs
   

2. 安裝Express：

   npm install -g express
   

3. 安裝http-server：

   npm install -g http-server
   

4. 下載并解壓Swagger UI：

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

5. 啟動Swagger UI：

   http-server -p 8080
   

6. 下載并解壓Swagger Editor：

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

7. 啟動Swagger Editor：

   http-server -p 8081
   

   現在，你可以通過訪問 http://<your-server-ip>:8080 來查看Swagger UI，通過訪問 http://<your-server-ip>:8081 來查看Swagger Editor。

配置Swagger

使用Spring Boot集成Swagger（適用于Spring Boot項目）

1. 添加依賴： 在 pom.xml 中添加以下依賴：

   <dependency>
       <groupId>org.springdoc</groupId>
       <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
       <version>2.1.0</version>
   </dependency>
   

2. 配置Swagger： 創建一個配置類：

   import io.swagger.v3.oas.annotations.OpenAPIDefinition;
   import io.swagger.v3.oas.annotations.info.Info;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   
   @Configuration
   @OpenAPIDefinition(info = @Info(title = "My API", version = "1.0"))
   public class SwaggerConfig {
   
       @Bean
       public Docket api() {
           return new Docket(DocumentationType.OAS_30)
                   .select()
                   .apis(RequestHandlerSelectors.any())
                   .paths(PathSelectors.any())
                   .build();
       }
   }
   

3. 啟動應用： 啟動你的Spring Boot應用，然后訪問 http://<your-server-ip>:8080/swagger-ui/ 查看Swagger文檔。

通過以上步驟，你可以在Linux環境下成功配置和運行Swagger UI和Swagger Editor。