Swagger在Linux上的集成開發環境怎么搭建

在Linux上集成Swagger可以顯著提高API文檔的生成和測試效率。以下是詳細的步驟，包括安裝必要的軟件、配置Swagger以及啟動和訪問Swagger UI。

1. 安裝Java環境和構建工具

首先，確保你的Linux系統上已經安裝了Java運行環境和構建工具（如Maven或Gradle）。

安裝Java環境

sudo apt update
sudo apt install openjdk-11-jdk

驗證安裝：

java -version

安裝Maven

sudo apt install maven

驗證安裝：

mvn -version

2. 配置Swagger依賴

根據你使用的構建工具，配置Swagger依賴。

Maven配置（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>

Gradle配置（build.gradle）

dependencies {
    implementation 'io.springfox:springfox-swagger2:2.9.2'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}

3. 創建Swagger配置類

創建一個Swagger配置類來啟用Swagger文檔生成。以下示例適用于Spring Boot和Spring MVC框架。

Spring Boot/Spring MVC配置類（SwaggerConfig.java）

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;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

4. 啟動應用程序

啟動你的Spring Boot或Spring MVC應用。Swagger會自動生成API文檔。

mvn clean install
java -jar target/your-application.jar

5. 訪問Swagger UI

在瀏覽器中訪問以下URL，即可查看和測試API文檔。

http://localhost:8080/swagger-ui.html

使用Docker簡化安裝過程（推薦）

安裝Docker

如果你的Linux系統還沒有安裝Docker，請先安裝它。

# 基于Debian的系統（如Ubuntu）
sudo apt update
sudo apt install docker.io

# 基于Red Hat的系統（如CentOS）
sudo yum install docker

安裝完成后，啟動Docker服務并設置開機自啟：

sudo systemctl start docker
sudo systemctl enable docker

部署Swagger Editor和Swagger UI

# 拉取Swagger Editor鏡像
docker pull swaggerapi/swagger-editor:v4.6.0

# 運行Swagger Editor容器
docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0

# 拉取Swagger UI鏡像
docker pull swaggerapi/swagger-ui:v4.15.5

# 運行Swagger UI容器
docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5

訪問以下URL即可使用Swagger Editor和Swagger UI：

• Swagger Editor: http://localhost:38080
• Swagger UI: http://localhost:38081

通過以上步驟，你就可以在Linux上成功集成Swagger，從而提高API文檔的生成和測試效率。