如何在Linux中使用Swagger進行API持續集成

在Linux中使用Swagger進行API持續集成，可以幫助你自動化生成API文檔并進行測試。以下是一個基本的步驟指南：

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

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

# 安裝OpenJDK
sudo apt update
sudo apt install openjdk-11-jdk

# 安裝Maven
sudo apt install maven

# 或者安裝Gradle
sudo apt install gradle

2. 添加Swagger依賴

在你的項目中添加Swagger依賴。如果你使用的是Maven，可以在 pom.xml 文件中添加以下依賴：

<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>

如果你使用的是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的示例配置：

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.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

4. 集成到持續集成工具

使用Jenkins

1. 安裝Jenkins：參考Jenkins官方文檔進行安裝。
2. 創建Jenkins Job：選擇“Freestyle project”，在“Source Code Management”部分選擇你的代碼倉庫（如Git），在“Build”部分添加一個“Invoke top-level Maven targets”構建步驟，輸入以下命令：

clean install

在“Post-build Actions”部分，添加一個“Publish JUnit test result report”步驟，配置你的測試報告路徑。

使用GitLab CI/CD

在你的項目根目錄下創建一個 .gitlab-ci.yml 文件，并添加以下內容：

stages:
  - build
  - test
  - document

build:
  stage: build
  script:
    - mvn clean install

test:
  stage: test
  script:
    - mvn test

document:
  stage: document
  script:
    - mvn springdoc:generate
  artifacts:
    paths:
      - target/generated-docs

提交并推送 .gitlab-ci.yml 文件到你的Git倉庫。

5. 訪問Swagger UI

一旦構建完成，你可以通過以下URL訪問Swagger UI：

http://your-application-url/swagger-ui.html

例如，如果你的應用程序運行在 localhost:8080 上，你可以訪問：

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

通過以上步驟，你可以在Linux系統中使用Swagger實現持續集成，自動化生成API文檔并進行測試。根據你的具體需求，可以選擇使用Jenkins或GitLab CI/CD等工具來實現這一流程。