在Spring Boot项目中使用Swagger2可以帮助我们生成API文档，并提供在线的接口测试功能。以下是一个简单的例子，展示如何在Spring Boot项目中集成Swagger2。
- 添加依赖到
pom.xml：
<dependencies>
<!-- Swagger2 -->
<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>
- 创建Swagger2配置类：
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
- 在Controller中使用Swagger注解标注接口规范：
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Api(value = "用户管理接口", tags = "UserController", description = "提供用户的增删改查操作")
public class UserController {
@GetMapping("/user")
@ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户信息")
public String getUser(@RequestParam(value = "id") String id) {
return "获取用户信息，用户ID：" + id;
}
}
- 启动Spring Boot应用，并访问
http://localhost:8080/swagger-ui.html查看生成的API文档。
以上代码提供了一个简单的Swagger2集成示例，包括配置类和一个使用Swagger注解的Controller。通过这个示例，开发者可以学习如何在Spring Boot项目中集成Swagger2，并使用Swagger2来规范化和文档化API接口。