本教程详细介绍如何在Spring Boot 2项目中整合使用Swagger-UI工具，帮助开发者快速构建和测试RESTful API接口。
Spring Boot 2 整合 Swagger UI 是为了提供一个交互式的文档系统，帮助开发者轻松地测试和理解API接口。Swagger UI 是基于 Swagger 的用户界面，它允许用户通过浏览器直接查看、测试和操作 API。
以下是对整合过程的详细解析：
1. **添加 Maven 依赖**
在 `pom.xml` 文件中引入两个关键的 Springfox 库：`springfox-swagger2` 和 `springfox-swagger-ui`。这两个依赖分别提供了 Swagger 的核心功能和用户界面。
```xml
io.springfox
springfox-swagger2
2.5.0
io.springfox
springfox-swagger-ui
2.5.0
```
版本号可能会有所不同，确保使用与你的 Spring Boot 版本兼容的版本。
2. **创建配置类**
创建一个配置类，并用 `@Configuration` 和 `@EnableSwagger2` 注解启用 Swagger2 功能。这个类通常和主应用类处于同一层级。
```java
package com.tydt.decision;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(com.tydt.decision.controller))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(Decision Manage Swagger RESTful APIs)
.description(Decision API)
.termsOfServiceUrl()
.contact(new Contact(, , ))
.version(1.0)
.build();
}
}
```
`createRestApi` 方法配置了 Swagger 的基本设置，包括 API 信息、选择控制器包进行扫描（这里是 `com.tydt.decision.controller`）以及所有路径。
3. **解决依赖冲突**
如果在启动应用时遇到错误，如 Error creating bean with name apiDocumentationScanner ，可能是由于依赖冲突。手动指定一个兼容的 Guava 版本可以解决问题。
```xml
com.google.guava
guava
15.0
```
4. **运行和使用 Swagger UI**
完成上述步骤后，重新构建并启动应用。Swagger UI 将在应用的 `swagger-ui.html` 路径下可用。例如，如果应用运行于 `http://localhost:8080` ，那么 Swagger UI 的地址就是 `http://localhost:8080/swagger-ui.html`。
这个界面将显示 API 列表，允许用户浏览描述、测试端点，并尝试各种请求方法（GET, POST, PUT 等）。
总结起来，Spring Boot 2 整合 Swagger UI 主要是通过添加依赖、创建配置类和解决潜在的依赖冲突来实现。这使得开发人员能够快速生成高质量的 API 文档，提高开发效率并促进团队间的协作。Swagger UI 让用户可以直接在浏览器中测试和调试 API ，从而简化了验证过程。
5星
