Spring Boot中的Swagger接口测试指南

# 1. **2.1 Swagger的安装和配置**

**2.1.1 Maven依赖添加**

在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>

**2.1.2 注解配置**

在主类上添加`@EnableSwagger2`注解，在需要生成API文档的控制器上添加`@Api`和`@ApiOperation`注解。例如：

@SpringBootApplication
@EnableSwagger2
public class SwaggerDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(SwaggerDemoApplication.class, args);
    }
}

@RestController
@RequestMapping("/api/users")
@Api(value = "用户管理", description = "用户管理相关接口")
public class UserController {

    @PostMapping
    @ApiOperation(value = "创建用户", notes = "创建新用户")
    public User createUser(@RequestBody User user) {
        // 省略实现
    }
}

# 2. Swagger接口测试基础

### 2.1 Swagger的安装和配置

#### 2.1.1 Maven依赖添加

在项目的pom.xml文件中添加以下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>

#### 2.1.2 注解配置

在Spring Boot主类上添加@EnableSwagger2注解，启用Swagger功能：

@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

### 2.2 Swagger文档生成

#### 2.2.1 API文档生成原理

Swagger通过扫描项目中的注解（如@RequestMapping、@RequestParam等）自动生成API文档。这些注解提供了接口路径、请求参数、返回类型等信息。

#### 2.2.2 文档生成配置

可以通过以下配置自定义文档生成：

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Swagger API")
            .description("API文档")
            .version("1.0")
            .build();
}

- `apiInfo()`方法设置API文档的基本信息，如标题、描