springboot2 集成swagger2

Spring Boot 2集成Swagger 2是一个常见的实践，用于创建RESTful API文档。Swagger（现在通常称为OpenAPI）是一个工具，它可以帮助开发者生成API的文档，并提供交互式界面让用户测试API。

以下是集成步骤：

1. 添加依赖：在`pom.xml`文件中添加Swagger相关的依赖，如`springfox-boot-starter-swagger2`。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter-swagger2</artifactId>
    <version>3.x.x</version> <!-- 根据最新版本替换 -->
</dependency>

2. 创建配置：在`application.yml`或`application.properties`中配置Swagger UI的相关信息，比如BasePath和标题等。

# application.yml
swagger:
  title: My API
  version: 1.0.0
  base-package: com.example.demo.controller

3. 注解扫描：在Spring Boot应用中，需要让Springfox扫描包含注解的地方，例如@ApiOperation、@GetMapping等。
4. 定义Controller：在Controller上使用Swagger注解来声明API，例如：

@RestController
@RequestMapping("/api")
@EnableSwagger2WebMvc
public class MyController {

    @ApiOperation(value = "获取用户列表")
    @GetMapping("/users")
    public List<User> getUsers() {
        // 返回用户列表
    }
}

5. 启动项目，访问`http://localhost:8080/swagger-ui.html`即可查看和测试API文档。