1.

在软件开发过程中，API文档的生成和测试是至关重要的环节。Swagger作为一款强大的API文档生成和管理工具，可以帮助开发者轻松地生成API文档并进行自动化测试。本文将详细介绍如何在Linux系统中使用Swagger实现持续集成。

2. 环境准备

在开始之前， 请确保你的Linux系统已满足以下要求：

• Java环境：Java 8或更高版本
• 构建工具：Maven或Gradle

2.1 安装Java环境

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

2.2 安装构建工具

# 安装Maven
sudo apt install maven
# 或者安装Gradle
sudo apt install gradle

3. 添加Swagger依赖

在你的项目中添加Swagger依赖，

    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

4. 配置Swagger

创建一个Swagger配置类来启用Swagger文档生成。

import io.swagger.v3.oas.models.OpenAPI;
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.oas.annotations.EnableOpenApi;
@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public OpenAPI api {
        return new OpenAPI
                .select
                .apis)
                .paths)
                .build;
    }
}

5. 集成到持续集成工具

5.1 使用Jenkins

1. 安装Jenkins：参考Jenkins官方文档进行安装。
2. 创建Jenkins Job：选择“Freestyle project”，并配置以下参数：
   • Source Code Management：选择你的代码仓库。
   • Build：添加“Invoke top-level Maven targets”构建步骤， 输入以下命令：

     clean install

   • Post-build Actions：添加“Publish JUnit test result report”步骤，配置你的测试报告路径。
3. 在项目根目录下创建一个 .gitlab-ci.yml 文件，并添加以下内容：
4. 提交并推送 .gitlab-ci.yml 文件到你的Git仓库。

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

一旦构建完成， 你可以通过以下URL访问Swagger UI：

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

比方说如果你的应用程序运行在 localhost:8080 上，你可以访问：

http://localhost:8080/swagger-ui

6.

API文档并进行测试。根据你的具体需求，可以选择使用Jenkins或GitLab CI/CD等工具来实现这一流程。

---